-
Notifications
You must be signed in to change notification settings - Fork 87
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
Update README #963
Conversation
@@ -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" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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 Report
@@ 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
Continue to review full report at Codecov.
|
|
||
#### Define objective | ||
#### Run AutoML |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A lot more assertive!
@dsherry there is some weird CircleCI thing though |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.)
There was a problem hiding this comment.
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.
@angela97lin haha most of those downloads are probably from our CI tests :) |
Fix broken image links, update content, add links to docs page
You can view what this will look like here.