Add docstrings for materializers and metadata_stores
#694
Conversation
This file contains hidden or 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
strickvl
added
documentation
fa9r
suggested changes
Jun 9, 2022
Contributor
fa9r
left a comment
fa9r
left a comment
There was a problem hiding this comment.
Great work, just added several minor questions/suggestions regarding wording below.
| # add modules to this list as/when they are completed. | ||
| # When we're done we can remove this and just use `SRC_NO_TESTS`. | ||
| DOCSTRING_SRC=${1:-"src/zenml/alerter src/zenml/artifact_stores src/zenml/artifacts src/zenml/config src/zenml/io src/zenml/model_deployers src/zenml/cli src/zenml/entrypoints src/zenml/experiment_trackers"} | ||
| DOCSTRING_SRC=${1:-"src/zenml/materializers src/zenml/metadata_stores"} |
Contributor
There was a problem hiding this comment.
Suggested change
| DOCSTRING_SRC=${1:-"src/zenml/materializers src/zenml/metadata_stores"} | |
| DOCSTRING_SRC=${1:-"src/zenml/alerter src/zenml/artifact_stores src/zenml/artifacts src/zenml/config src/zenml/io src/zenml/model_deployers src/zenml/cli src/zenml/entrypoints src/zenml/experiment_trackers src/zenml/materializers src/zenml/metadata_stores"} |
Contributor
Author
There was a problem hiding this comment.
I'm not quite sure what happened here?
Contributor
Author
There was a problem hiding this comment.
I think I understand. This docstring.sh is a temporary script that will probably go away once the main docstring PR is merged. I think this can be ignored.
Comment on lines
-103
to
-105
| Returns: | ||
| Any object that is to be passed into the relevant artifact in the | ||
| step. |
Contributor
Author
There was a problem hiding this comment.
Because it doesn't actually return that...
| Args: | ||
| executions: List of executions. | ||
| pipeline: PipelineView. |
| """Gets all runs for the given pipeline. | ||
| Args: | ||
| pipeline: PipelineView. |
Co-authored-by: Felix Altenberger <felix@zenml.io>
Co-authored-by: Felix Altenberger <felix@zenml.io>
Co-authored-by: Felix Altenberger <felix@zenml.io>
Co-authored-by: Felix Altenberger <felix@zenml.io>
…/zenml into misc/ENG-955-ENG-956-docstrings
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.
I added docstrings for
materializersandmetadata_stores.Pre-requisites
Please ensure you have done the following:
Types of changes