This repository has been archived by the owner on Aug 26, 2024. It is now read-only.
Add documentation for what functions invoked in model.train as in model.predict #180
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
cosmicBboy
reviewed
Oct 4, 2022
unionml/model.py
Outdated
| @@ -514,15 +514,19 @@ def train( | |||
|
|
|||
| :param hyperparameters: a dictionary mapping hyperparameter names to values. This is passed into the | |||
| ``init`` callable to initialize a model object. | |||
| :param loader_kwargs: key-word arguments to pass to the registered :meth:`unionml.Dataset.loader` function. | |||
| :param loader_kwargs: key-word arguments to pass to the registered | |||
There was a problem hiding this comment.
hi @bilal-aamer wanted to clarify the updates needed for #148.
It needs to list the tasks that are invoked in the training workflow.
Can you revert the changes that you made below and add a paragraph below the argument docstrings, something like:
The train method invokes an execution graph that composes together the following functions to train and evaluate a model:
- :meth:`unionml.Dataset.reader`
- :meth:`unionml.Dataset.loader`
- :meth:`unionml.Dataset.splitter`
- :meth:`unionml.Dataset.parser`
- :meth:`unionml.Model.trainer`
- :meth:`unionml.Model.predictor`
- :meth:`unionml.Model.evaluator`
There was a problem hiding this comment.
Done! @cosmicBboy ! Please Review!
cosmicBboy
approved these changes
Oct 5, 2022
|
No, thank you @cosmicBboy 👍🏼 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
#148
Updated the docs of the
unionml.model.Model.trainmethod to show what functions are invoked as done in themodel.predictmethod.