awslabs / awslabs/deequ

Add markdown documentation for an AnalysisRunner example

Open Beginner friendly
#39 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Scala
Stars
3.6k
Forks
586
Avg merge
13d 13h
Merged PRs (30d)
1

Description

The AnalysisRunner is our main entry point for calculating metrics in a scenario where you don't want to write unit tests but want to do something different with the metrics. We need to make the distinction between the AnalysisRunner and the ColumnProfilerRunner clear.

Contributor guide

Open the contributing guide

Research direction

The entry points named are AnalysisRunner and ColumnProfilerRunner; start by locating their existing documentation and examples in the repository. Add a Markdown example explaining when to use AnalysisRunner instead of ColumnProfilerRunner and verify that the distinction and non-unit-test metrics workflow are clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala, spark
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
66/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.