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

Shorten results output in docs #3328

Merged
merged 9 commits into from
Feb 15, 2022
Merged

Shorten results output in docs #3328

merged 9 commits into from
Feb 15, 2022

Conversation

bchen1116
Copy link
Contributor

@bchen1116 bchen1116 commented Feb 14, 2022

fix #3032

Rather than editing the output of the results themselves, I figured the better approach would be to truncate the cell output for this.

image

https://feature-labs-inc-evalml--3328.com.readthedocs.build/en/3328/user_guide/automl.html#Access-raw-results

@bchen1116 bchen1116 self-assigned this Feb 14, 2022
@codecov
Copy link

codecov bot commented Feb 14, 2022

Codecov Report

Merging #3328 (8ae2689) into main (95aa7e2) will decrease coverage by 0.7%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            main   #3328     +/-   ##
=======================================
- Coverage   99.7%   99.0%   -0.6%     
=======================================
  Files        327     327             
  Lines      31840   31840             
=======================================
- Hits       31715   31494    -221     
- Misses       125     346    +221     
Impacted Files Coverage Δ
evalml/automl/pipeline_search_plots.py 17.9% <0.0%> (-82.1%) ⬇️
...l/tests/automl_tests/test_pipeline_search_plots.py 23.3% <0.0%> (-76.7%) ⬇️
...ests/automl_tests/test_automl_search_regression.py 74.3% <0.0%> (-20.4%) ⬇️
.../automl_tests/test_automl_search_classification.py 83.8% <0.0%> (-12.6%) ⬇️
evalml/tests/automl_tests/test_automl_utils.py 91.1% <0.0%> (-8.9%) ⬇️
...lml/tests/automl_tests/test_iterative_algorithm.py 92.3% <0.0%> (-7.7%) ⬇️
evalml/automl/utils.py 98.5% <0.0%> (-1.5%) ⬇️
evalml/automl/automl_search.py 99.6% <0.0%> (-0.1%) ⬇️
evalml/tests/automl_tests/test_automl.py 99.4% <0.0%> (-<0.1%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 95aa7e2...8ae2689. Read the comment docs.

@bchen1116 bchen1116 changed the title Add scroll to results output in docs Shorten results output in docs Feb 14, 2022
Copy link
Contributor

@freddyaboulton freddyaboulton left a comment

Choose a reason for hiding this comment

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

Thanks @bchen1116 ! This looks good to me. If we decide we need a pprint call in more places in the docs we can invest in trying to find a way to apply the pretty-printing automatically.

@@ -657,7 +657,10 @@
"metadata": {},
"outputs": [],
"source": [
"automl.results"
"import pprint\n",
"pp = pprint.PrettyPrinter(indent=0, width=100, depth=3, compact=True, sort_dicts=False)\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

could we set depth=2 and then showcase just one pipelines results with:
automl.results['pipeline_results'][0]? I still think the output is rather long and takes multiple scrolls to get through.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My main worry is that depth=2 gives users very little information:
image

I can definitely try to combine it with your latter suggestion and see how it works!

Copy link
Collaborator

Choose a reason for hiding this comment

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

ah true that doesn't look the best.. lmk if adding more information will make it better but def not blocking!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

I like the previous better. will change back!

Copy link
Contributor

@angela97lin angela97lin left a comment

Choose a reason for hiding this comment

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

Thanks @bchen1116! Agreed with @freddyaboulton that it could be a good idea to do this automagically if we run into it more in the future but this is great 😁

@bchen1116 bchen1116 enabled auto-merge (squash) February 15, 2022 05:00
@bchen1116 bchen1116 merged commit 7da8a8e into main Feb 15, 2022
@chukarsten chukarsten mentioned this pull request Feb 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Access Raw Results Output is too long
4 participants