Skip to content

Commit

Permalink
Model provenance - argument description (#377)
Browse files Browse the repository at this point in the history
  • Loading branch information
o-alex authored Nov 10, 2024
1 parent bcc435b commit 0ed069f
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions python/hsml/llm/signature.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ def create_model(
`""`.
input_example: Optionally an input example that represents a single input for the model, defaults to `None`.
model_schema: Optionally a model schema for the model inputs and/or outputs.
feature_view: Optionally a feature view object returned by querying the feature store. If the feature view is not provided, the model will not have access to provenance.
training_dataset_version: Optionally a training dataset version. If training dataset version is not provided, but the feature view is provided, the training dataset version used will be the last accessed training dataset of the feature view, within the code/notebook that reads the feature view and training dataset and then creates the model.
# Returns
`Model`. The model metadata object.
Expand Down
2 changes: 2 additions & 0 deletions python/hsml/python/signature.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ def create_model(
`""`.
input_example: Optionally an input example that represents a single input for the model, defaults to `None`.
model_schema: Optionally a model schema for the model inputs and/or outputs.
feature_view: Optionally a feature view object returned by querying the feature store. If the feature view is not provided, the model will not have access to provenance.
training_dataset_version: Optionally a training dataset version. If training dataset version is not provided, but the feature view is provided, the training dataset version used will be the last accessed training dataset of the feature view, within the code/notebook that reads the feature view and training dataset and then creates the model.
# Returns
`Model`. The model metadata object.
Expand Down
2 changes: 2 additions & 0 deletions python/hsml/sklearn/signature.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ def create_model(
`""`.
input_example: Optionally an input example that represents a single input for the model, defaults to `None`.
model_schema: Optionally a model schema for the model inputs and/or outputs.
feature_view: Optionally a feature view object returned by querying the feature store. If the feature view is not provided, the model will not have access to provenance.
training_dataset_version: Optionally a training dataset version. If training dataset version is not provided, but the feature view is provided, the training dataset version used will be the last accessed training dataset of the feature view, within the code/notebook that reads the feature view and training dataset and then creates the model.
# Returns
`Model`. The model metadata object.
Expand Down
2 changes: 2 additions & 0 deletions python/hsml/tensorflow/signature.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ def create_model(
`""`.
input_example: Optionally an input example that represents a single input for the model, defaults to `None`.
model_schema: Optionally a model schema for the model inputs and/or outputs.
feature_view: Optionally a feature view object returned by querying the feature store. If the feature view is not provided, the model will not have access to provenance.
training_dataset_version: Optionally a training dataset version. If training dataset version is not provided, but the feature view is provided, the training dataset version used will be the last accessed training dataset of the feature view, within the code/notebook that reads the feature view and training dataset and then creates the model.
# Returns
`Model`. The model metadata object.
Expand Down
2 changes: 2 additions & 0 deletions python/hsml/torch/signature.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ def create_model(
`""`.
input_example: Optionally an input example that represents a single input for the model, defaults to `None`.
model_schema: Optionally a model schema for the model inputs and/or outputs.
feature_view: Optionally a feature view object returned by querying the feature store. If the feature view is not provided, the model will not have access to provenance.
training_dataset_version: Optionally a training dataset version. If training dataset version is not provided, but the feature view is provided, the training dataset version used will be the last accessed training dataset of the feature view, within the code/notebook that reads the feature view and training dataset and then creates the model.
# Returns
`Model`. The model metadata object.
Expand Down

0 comments on commit 0ed069f

Please sign in to comment.