Clean up lacking codecov for main.py and add `evalml info` to docs #1293

angela97lin · 2020-10-09T20:26:13Z

Closes #796
Updated docs here: https://evalml.alteryx.com/en/796_cli_check/user_guide/utilities.html

Fixes broken CLI evalml info. Try pip installing evalml and running evalml info--it currently breaks. Then, try using pip install git+ssh://git@github.com/alteryx/evalml.git@796_cli_check to install in fresh environment, cli should work now :)
Removes lines of code because it doesn't affect functionality and were previously missed by codecov.
I think current coverage of evalml info to the logger output suffices, capsys and caplog don't play really well with each other 😬

codecov · 2020-10-09T20:27:36Z

Codecov Report

Merging #1293 into main will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1293   +/-   ##
=======================================
  Coverage   99.94%   99.94%           
=======================================
  Files         213      213           
  Lines       13387    13385    -2     
=======================================
- Hits        13379    13378    -1     
+ Misses          8        7    -1

Impacted Files	Coverage Δ
evalml/__main__.py	`100.00% <ø> (+9.09%)`	⬆️

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 55e1776...05344f6. Read the comment docs.

angela97lin · 2020-10-12T21:46:37Z

setup.py

@@ -22,5 +22,8 @@
        ]
    },
    data_files=[('evalml/demos/data', ['evalml/demos/data/fraud_transactions.csv.tar.gz', 'evalml/demos/data/churn.csv']),
-                ("evalml/tests/data", ['evalml/tests/data/tips.csv', 'evalml/tests/data/titanic.csv'])]
+                ('evalml/tests/data', ['evalml/tests/data/tips.csv', 'evalml/tests/data/titanic.csv'])],
+    package_data = {


We need to add core-requirements.txt to package_data so that it is included in the binary distribution and available via pip installation.

This would install the core-requirements.txt file at the site-packages level instead of site-packages/evalml . It seems kind of weird that we would read a file that is technically not in our package and it could also conflict with other files called core-requirements.txt.

I think I would prefer the hardcode-a-list-of-requirements approach I think you mentioned at stand-up the other day.

Also, I think we should check if the ../ syntax works on windows?

@angela97lin @freddyaboulton ah, I see what you're talking about. The current impl of the evalml info CLI happens to read in core-requirements.txt in order to do its thing.

I suggest we change the impl instead:

In cli_utils.py delete get_core_requirements()

And update print_deps():

def print_deps(dependencies): logger.info("\nINSTALLED VERSIONS") logger.info("------------------") installed_packages = get_installed_packages() packages_to_log = [] for package in installed_packages: packages_to_log.append((x, installed_packages[x])) logger.info("{package}: {version}".format(package=package, version=installed_packages[package]))

Will that work?

Also. good point about the pathing! So I think that data_files and package_data are used during package creation, meaning they need to work on whatever platform we build source dist / wheels on. We currently do this on linux. So, we're ok for now :)

@dsherry @freddyaboulton

Hm, is this what we want though? By removing get_core_requirements() / just calling get_installed_packages(), we're getting all of the packages the user has installed, regardless of if it is an evalml dependency or not. I'd argue then that this is not much more useful than pip freeze. If there's no good workaround, I'm okay with just having a hardcoded list as Featuretools has. Thoughts?

dsherry

@angela97lin thanks for looking at this and for adding that guide!

I left a suggestion on the impl. Basically, I wonder if instead of packaging core-requirements.txt, we can just change the impl to log out the entirety of pip freeze. Let's conclude that conversation one way or another, and then I'll happily approve.

dsherry · 2020-10-14T21:13:01Z

evalml/__main__.py

-
-
-if __name__ == '__main__':
-    cli()


Hmm, so this isn't needed for click to work?

dsherry · 2020-10-14T21:21:42Z

setup.py

@@ -22,5 +22,8 @@
        ]
    },
    data_files=[('evalml/demos/data', ['evalml/demos/data/fraud_transactions.csv.tar.gz', 'evalml/demos/data/churn.csv']),
-                ("evalml/tests/data", ['evalml/tests/data/tips.csv', 'evalml/tests/data/titanic.csv'])]
+                ('evalml/tests/data', ['evalml/tests/data/tips.csv', 'evalml/tests/data/titanic.csv'])],
+    package_data = {


@angela97lin @freddyaboulton ah, I see what you're talking about. The current impl of the evalml info CLI happens to read in core-requirements.txt in order to do its thing.

I suggest we change the impl instead:

In cli_utils.py delete get_core_requirements()

And update print_deps():

def print_deps(dependencies): logger.info("\nINSTALLED VERSIONS") logger.info("------------------") installed_packages = get_installed_packages() packages_to_log = [] for package in installed_packages: packages_to_log.append((x, installed_packages[x])) logger.info("{package}: {version}".format(package=package, version=installed_packages[package]))

Will that work?

Also. good point about the pathing! So I think that data_files and package_data are used during package creation, meaning they need to work on whatever platform we build source dist / wheels on. We currently do this on linux. So, we're ok for now :)

dsherry · 2020-10-20T16:21:09Z

docs/source/user_guide/utilities.ipynb

+    "## System Information\n",
+    "\n",
+    "EvalML provides a command-line interface (CLI) tool prints the version of EvalML and core dependencies installed, as well as some basic system information. To use this tool, just run `evalml info` in your shell or terminal. This could be useful for debugging purposes or tracking down any version-related issues."
+   ]


@angela97lin I think there's a bug somewhere -- the output shows a stack trace in the docs

My bad, I was testing out the suggestion you made. Reverted to working state here (https://evalml.alteryx.com/en/796_cli_check/user_guide/utilities.html) until we discuss.

dsherry

Discussed with @angela97lin . Plan:

Merge this PR, since it adds missing code coverage
File issue to track removing core-requirements.txt from our package, and update the env CLI to list all installed packages (i.e. pip freeze)

angela97lin · 2020-10-21T16:49:26Z

@dsherry Filed #1328, so this should be good to merge!

remove unncecessary line

3ff0492

angela97lin added this to the October 2020 milestone Oct 9, 2020

angela97lin self-assigned this Oct 9, 2020

angela97lin added 21 commits October 9, 2020 16:57

add to docs

af0dd31

try

eea4424

try

d1e75dc

more test

ba4af46

change

56fb230

test

3500c4a

test

16d98f0

test

1562769

more test

ef38e9a

test

9496dbe

test

5cfc6d8

test

ef897bc

test

5f59754

tst

90a0d9f

more test'

3f4b29c

hm

f266c34

more testing

18af4f3

cleanup

08c6c2b

testing

7c29b97

testing

74c681c

cleanup

7797821

angela97lin commented Oct 12, 2020

View reviewed changes

Merge branch 'main' into 796_cli_check

d2898b7

angela97lin marked this pull request as ready for review October 13, 2020 14:48

angela97lin requested review from dsherry and freddyaboulton October 13, 2020 14:48

angela97lin requested review from bchen1116 and jeremyliweishih October 13, 2020 14:48

dsherry suggested changes Oct 14, 2020

View reviewed changes

angela97lin added 2 commits October 14, 2020 22:25

Merge branch 'main' into 796_cli_check

4f29c79

testing

3ec1303

dsherry reviewed Oct 20, 2020

View reviewed changes

angela97lin added 3 commits October 20, 2020 12:57

revert

8b82d27

merge

335e6f5

Merge branch 'main' into 796_cli_check

f3b71f1

dsherry approved these changes Oct 21, 2020

View reviewed changes

angela97lin added 2 commits October 21, 2020 12:14

Merge branch 'main' into 796_cli_check

e74fb97

Merge branch 'main' into 796_cli_check

05344f6

angela97lin mentioned this pull request Oct 21, 2020

Remove core-requirements.txt from installed package #1328

Closed

angela97lin merged commit 2ed93c7 into main Oct 21, 2020

angela97lin deleted the 796_cli_check branch October 21, 2020 18:36

dsherry mentioned this pull request Oct 29, 2020

Release v0.15.0 #1370

Merged

freddyaboulton mentioned this pull request Nov 12, 2020

Removing core-requirements from installed package #1429

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up lacking codecov for main.py and add `evalml info` to docs #1293

Clean up lacking codecov for main.py and add `evalml info` to docs #1293

angela97lin commented Oct 9, 2020 •

edited

Loading

codecov bot commented Oct 9, 2020 •

edited

Loading

angela97lin Oct 12, 2020

freddyaboulton Oct 14, 2020

dsherry Oct 14, 2020

angela97lin Oct 15, 2020 •

edited

Loading

dsherry left a comment

dsherry Oct 14, 2020

dsherry Oct 14, 2020

dsherry Oct 20, 2020 •

edited

Loading

angela97lin Oct 20, 2020

dsherry left a comment

angela97lin commented Oct 21, 2020

Clean up lacking codecov for __main__.py and add evalml info to docs #1293

Clean up lacking codecov for __main__.py and add evalml info to docs #1293

Conversation

angela97lin commented Oct 9, 2020 • edited Loading

codecov bot commented Oct 9, 2020 • edited Loading

Codecov Report

angela97lin Oct 12, 2020

Choose a reason for hiding this comment

freddyaboulton Oct 14, 2020

Choose a reason for hiding this comment

dsherry Oct 14, 2020

Choose a reason for hiding this comment

angela97lin Oct 15, 2020 • edited Loading

Choose a reason for hiding this comment

dsherry left a comment

Choose a reason for hiding this comment

dsherry Oct 14, 2020

Choose a reason for hiding this comment

dsherry Oct 14, 2020

Choose a reason for hiding this comment

dsherry Oct 20, 2020 • edited Loading

Choose a reason for hiding this comment

angela97lin Oct 20, 2020

Choose a reason for hiding this comment

dsherry left a comment

Choose a reason for hiding this comment

angela97lin commented Oct 21, 2020

Clean up lacking codecov for main.py and add `evalml info` to docs #1293

Clean up lacking codecov for main.py and add `evalml info` to docs #1293

angela97lin commented Oct 9, 2020 •

edited

Loading

codecov bot commented Oct 9, 2020 •

edited

Loading

angela97lin Oct 15, 2020 •

edited

Loading

dsherry Oct 20, 2020 •

edited

Loading