Update the Dataset Object Documentation #500
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ItayGabbay
reviewed
Jan 5, 2022
There was a problem hiding this comment.
I really like the writing style!
Some comments:
- I didn't comment on wordings
- I think we need to show more functionalities about the dataset, for example functions like copy, from_numpy, datetime parsing, passing labels as series, and more.
- We can take inspiration from a not-so-related library which in my opinion has a great quickstart:
https://numpy.org/doc/stable/user/quickstart.html
ItayGabbay
added
kind/feature
and removed
documentation
benisraeldan
force-pushed
the
dc-484-dataset-object-documentation
branch
from
74609a6
to
0b4f0df
Compare
ItayGabbay
requested changes
Jan 5, 2022
| - features | ||
| List of column names. This is the features that are passed to the model. If not defined, columns not defined as something else is considered a feature. | ||
| - cat_features | ||
| List of column names. A subset of the features. Categorical features normally require some preprocessing before being passed to the model. |
There was a problem hiding this comment.
Suggested change
| List of column names. A subset of the features. Categorical features normally require some preprocessing before being passed to the model. | |
| List of column names. A subset of the features. Categorical features normally require some preprocessing before being passed to the model. If not specified, the categorical features are inferred automatically from the data itself. |
There was a problem hiding this comment.
And also we should line here to the categorical inference heuristic detailed below.
There was a problem hiding this comment.
See my general note above about phrasing
| List of column names. This is the features that are passed to the model. If not defined, columns not defined as something else is considered a feature. | ||
| - cat_features | ||
| List of column names. A subset of the features. Categorical features normally require some preprocessing before being passed to the model. | ||
| - label |
There was a problem hiding this comment.
Actually, when reading the doc I think we should rename the label parameter to target.
What do you guys think?
@shir22 @noamzbr @benisraeldan @matanper @nirhutnik @JKL98ISR
There was a problem hiding this comment.
I tend to agree that target feels a bit smoother
ItayGabbay
added
feature
shir22
requested changes
Jan 5, 2022
| List of column names. This is the features that are passed to the model. If not defined, columns not defined as something else is considered a feature. | ||
| - cat_features | ||
| List of column names. A subset of the features. Categorical features normally require some preprocessing before being passed to the model. | ||
| - label |
There was a problem hiding this comment.
I tend to agree that target feels a bit smoother
| - features | ||
| List of column names. This is the features that are passed to the model. If not defined, columns not defined as something else is considered a feature. | ||
| - cat_features | ||
| List of column names. A subset of the features. Categorical features normally require some preprocessing before being passed to the model. |
There was a problem hiding this comment.
See my general note above about phrasing
shir22
previously requested changes
Jan 5, 2022
…dc-484-dataset-object-documentation
ItayGabbay
approved these changes
Jan 7, 2022
delete-merged-branch
bot
deleted the
dc-484-dataset-object-documentation
branch
ItayGabbay
pushed a commit
that referenced
this pull request
Jan 7, 2022
Update to user guide Small updates to readme and index
ItayGabbay
added a commit
that referenced
this pull request
Jan 9, 2022
* 0.2.0 version bump * docs fixes * Fix PerfectModel when data have nulls in label (#526) * - Adding iris to the datasets section (#530) - changing quickstart to use iris from the datasets section * Update the Dataset Object Documentation (#500) Update to user guide Small updates to readme and index * version bump Co-authored-by: matanper <matan@deepchecks.com> Co-authored-by: DBI <42312361+benisraeldan@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
Resolves #484