Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Provide ability for DataAssistant to return its effective underlying BaseRuleBasedProfiler configuration #5359

Conversation

alexsherstinsky
Copy link
Contributor

Scope

By returning JSON configuration of its underlying Rule-Based Profiler by a DataAssistant, it becomes possible to introspect this JSON structure and determine runtime-environment overrides programmatically.

Usage Example:

context.assistants.onboarding.get_profiler_config()

By default , JSON-formatted structure is returned. Other available formats are as per ConfigOutputModes in great_expectations/core/config_peer.py.

Please annotate your PR title to describe what the PR does, then give a brief bulleted description of your PR below. PR titles should begin with [BUGFIX], [FEATURE], [DOCS], or [MAINTENANCE]. If a new feature introduces breaking changes for the Great Expectations API or configuration files, please also add [BREAKING]. You can read about the tags in our contributor checklist.

Changes proposed in this pull request:

  • JIRA: GREAT-761/GREAT-1016

After submitting your PR, CI checks will run and @cla-bot will check for your CLA signature.

For a PR with nontrivial changes, we review with both design-centric and code-centric lenses.

In a design review, we aim to ensure that the PR is consistent with our relationship to the open source community, with our software architecture and abstractions, and with our users' needs and expectations. That review often starts well before a PR, for example in github issues or slack, so please link to relevant conversations in notes below to help reviewers understand and approve your PR more quickly (e.g. closes #123).

Previous Design Review notes:

Definition of Done

Please delete options that are not relevant.

  • My code follows the Great Expectations style guide
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added unit tests where applicable and made sure that new and existing tests are passing.
  • I have run any local integration tests and made sure that nothing is broken.

Thank you for submitting!

Alex Sherstinsky and others added 30 commits June 15, 2022 15:41
…4/GREAT-999/alexsherstinsky/rule_based_profiler/data_assistant/data_assistant_result/move_getting_expectation_suite_to_expectation_suite_class-2022_06_15-170
…/alexsherstinsky/rule_based_profiler/remove_json_serialize_directive_and_add_raw_parameter_builder_computation_results_to_json_serialized_results-2022_06_15-170
…/alexsherstinsky/rule_based_profiler/remove_json_serialize_directive_and_add_raw_parameter_builder_computation_results_to_json_serialized_results-2022_06_15-170
…/alexsherstinsky/rule_based_profiler/remove_json_serialize_directive_and_add_raw_parameter_builder_computation_results_to_json_serialized_results-2022_06_15-170
…ror-changelog' into maintenance/GREAT-467/GREAT-464/GREAT-999/alexsherstinsky/rule_based_profiler/remove_json_serialize_directive_and_add_raw_parameter_builder_computation_results_to_json_serialized_results-2022_06_15-170
…ky/rule_based_profiler/remove_json_serialize_directive_and_add_raw_parameter_builder_computation_results_to_json_serialized_results-2022_06_15-170' into pre_pr-prototype/maintenance/GREAT-467/GREAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…exsherstinsky/rule_based_profiler/enable_numeric_metric_range_multibatch_parameter_builder_to_use_evaluation_dependencies-2022_06_16-171
…EAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…rule_based_profiler/enable_numeric_metric_range_multibatch_parameter_builder_to_use_evaluation_dependencies-2022_06_16-171' into pre_pr-prototype/maintenance/GREAT-467/GREAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…/maintenance/GREAT-467/GREAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…EAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…EAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
Alex Sherstinsky added 13 commits June 16, 2022 17:16
…EAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…/maintenance/GREAT-467/GREAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…EAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…EAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
…/maintenance/GREAT-467/GREAT-464/GREAT-1000/alexsherstinsky/rule_based_profiler/data_assistant/onboarding_data_assistant/performance_improvements-2022_06_15-171
@netlify
Copy link

netlify bot commented Jun 21, 2022

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit 9a4d43b
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/62b253bbf98e750008c3e990
😎 Deploy Preview https://deploy-preview-5359--niobium-lead-7998.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@ghost
Copy link

ghost commented Jun 21, 2022

👇 Click on the image for a new way to code review
  • Make big changes easier — review code in small groups of related files

  • Know where to start — see the whole change at a glance

  • Take a code tour — explore the change with an interactive tour

  • Make comments and review — all fully sync’ed with github

    Try it now!

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map Legend

rules: name/(configuration-dictionary) to modify using "runtime_environment"
kwargs: additional/override directives supplied at runtime
batch_request: Explicit batch_request used to supply data at runtime
kwargs: additional/override directives supplied at runtime (using "runtime_environment")
"kwargs" directives structure:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very helpful to include this. Thank you Alex

CARDINALITY_LIMIT_MODE = "cardinality_limit_mode"
MAX_UNIQUE_VALUES = "max_unique_values"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if I missed this, but I was wondering if these values were actually used in this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Shinnnyshinshin this is for runtime_environment (the kwargs into DataAssistant.run(). Thanks!

Copy link
Contributor

@Shinnnyshinshin Shinnnyshinshin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, with one question :)

…based_profiler/data_assistant/provide_ability_to_obtain_defined_effective_underlying_rule_based_profiler_configuration-2022_06_21-178
@alexsherstinsky alexsherstinsky enabled auto-merge (squash) June 22, 2022 00:00
@alexsherstinsky alexsherstinsky merged commit 10488ee into develop Jun 22, 2022
@alexsherstinsky alexsherstinsky deleted the feature/GREAT-761/GREAT-1016/alexsherstinsky/rule_based_profiler/data_assistant/provide_ability_to_obtain_defined_effective_underlying_rule_based_profiler_configuration-2022_06_21-178 branch June 22, 2022 00:43
Shinnnyshinshin pushed a commit that referenced this pull request Jun 22, 2022
…-context-logict-abstract

* develop:
  [MAINTENANCE] Move `_apply_global_config_overrides()` to AbstractDataContext (#5285)
  chore: update linter thresholds (#5367)
  [MAINTENANCE] Reduce output amount in Jupyter notebooks when displaying DataAssistantResult (#5362)
  [RELEASE] 0.15.11 (#5361)
  chore: update gh action (#5363)
  [MAINTENANCE] Include only essential public methods in DataAssistantResult class (and its descendants) (#5360)
  [FEATURE] Provide ability for DataAssistant to return its effective underlying BaseRuleBasedProfiler configuration (#5359)
  [FEATURE] Update `add_datasource` to leverage the `DatasourceStore` (#5334)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants