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

Update README #963

Merged
merged 8 commits into from Jul 22, 2020
Merged

Update README #963

merged 8 commits into from Jul 22, 2020

Conversation

dsherry
Copy link
Collaborator

@dsherry dsherry commented Jul 22, 2020

Fix broken image links, update content, add links to docs page

You can view what this will look like here.

@@ -1,68 +1,58 @@
<p align="center">
<img width=50% src="https://github.com/featurelabs/evalml/blob/main/docs/source/images/evalml_logo.png?raw=true" alt="Featuretools" />
<img width=50% src="https://evalml-web-images.s3.amazonaws.com/evalml_horizontal.svg" alt="Featuretools" />
Copy link
Collaborator Author

@dsherry dsherry Jul 22, 2020

Choose a reason for hiding this comment

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

To get this to work, I created an S3 bucket here and grabbed public links for the images. Appears to work fine.

Looks like featuretools does something slightly different. @rwedge do you have any thoughts on this?

Copy link
Contributor

@rwedge rwedge Jul 22, 2020

Choose a reason for hiding this comment

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

@dsherry featuretools also uses a public link to the logo image, but using a featuretools.com domain instead

@codecov
Copy link

codecov bot commented Jul 22, 2020

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #963      +/-   ##
==========================================
+ Coverage   99.66%   99.87%   +0.20%     
==========================================
  Files         171      171              
  Lines        8780     8780              
==========================================
+ Hits         8751     8769      +18     
+ Misses         29       11      -18     
Impacted Files Coverage Δ
evalml/automl/automl_search.py 99.55% <0.00%> (+0.44%) ⬆️
.../automl_tests/test_automl_search_classification.py 100.00% <0.00%> (+0.45%) ⬆️
evalml/tests/component_tests/test_components.py 100.00% <0.00%> (+0.61%) ⬆️
evalml/tests/pipeline_tests/test_pipelines.py 100.00% <0.00%> (+0.86%) ⬆️
...ests/automl_tests/test_automl_search_regression.py 100.00% <0.00%> (+1.06%) ⬆️
evalml/utils/gen_utils.py 100.00% <0.00%> (+2.63%) ⬆️
evalml/tests/component_tests/test_utils.py 100.00% <0.00%> (+3.57%) ⬆️
evalml/tests/utils_tests/test_dependencies.py 100.00% <0.00%> (+12.50%) ⬆️

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 f532c08...69bdf53. Read the comment docs.


#### Define objective
#### Run AutoML
Copy link
Collaborator Author

@dsherry dsherry Jul 22, 2020

Choose a reason for hiding this comment

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

I like the idea of leading with a custom objective, but I'd rather have this content be super simple and then provide links to our tutorials and user guide, which are more thorough and show evaluation output.

Copy link
Contributor

@jeremyliweishih jeremyliweishih left a comment

LGTM jeremy-approve


EvalML is an AutoML library to build optimized machine learning pipelines for domain-specific objective functions.
EvalML is an AutoML library that builds, optimizes, and evaluates machine learning pipelines using domain-specific objective functions.
Copy link
Contributor

@jeremyliweishih jeremyliweishih Jul 22, 2020

Choose a reason for hiding this comment

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

A lot more assertive!

@jeremyliweishih
Copy link
Contributor

jeremyliweishih commented Jul 22, 2020

@dsherry there is some weird CircleCI thing though

Copy link
Contributor

@angela97lin angela97lin left a comment

LGTM! I love the new changes and can't wait for next release :D

(Do we really have >100 downloads a month already??)

* **Domain-specific** - Includes repository of domain-specific objective functions and interface to define your own
* **End-to-end** - Constructs and optimizes pipelines that include imputation, feature selection, and a variety of modeling techniques
* **Data Checks** - Carefully cross-validates to prevent overfitting and warns you if training and testing results diverge
* **Automation** - Makes machine learning easier. Avoid training and tuning models by hand. Includes data quality checks, cross-validation and more.
Copy link
Contributor

@angela97lin angela97lin Jul 22, 2020

Choose a reason for hiding this comment

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

Should we go with Avoids / keep simple present tense as we have with the rest of the sentences?

Copy link
Contributor

@angela97lin angela97lin Jul 22, 2020

Choose a reason for hiding this comment

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

(I like avoid better but it just stood out to me amongst the other sentences here haha.)

Copy link
Collaborator Author

@dsherry dsherry Jul 22, 2020

Choose a reason for hiding this comment

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

Hmm, so using "Avoids" here implies the subject is evalml, but using "Avoid" implies the subject is the user, which I like. Perhaps there's a better way to articulate this though. If you have ideas I'm all ears.

@dsherry
Copy link
Collaborator Author

dsherry commented Jul 22, 2020

@angela97lin haha most of those downloads are probably from our CI tests :)

@dsherry dsherry merged commit a8147aa into main Jul 22, 2020
2 checks passed
@dsherry dsherry deleted the ds_948 branch Jul 22, 2020
@angela97lin angela97lin mentioned this pull request Jul 31, 2020
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.

None yet

4 participants