SDK Types
All types in the SDK
_InternalNamespace
Module:ml.internal_namespace
_ModelFramework
Module:ml.model_framework
_SerializationFormatLoaderRegistry
Module:ml.model_framework
ActiveRuns
Module:ml.session
AppName
Custom ParamType to validate application names Module:ml.utils
Custom ParamType to validate application names.
Union, One Of:
ArtifactIdentifier
Module:ml.truefoundry_artifact_repo
ArtifactPath
Module:ml.artifact
ArtifactVersion
Module:ml.artifact
Get the name of the artifact
Get fqn of the artifact
Get version information of the artifact
Get fqn of the current artifact version
Get the step in which artifact was created
Get description of the artifact
Get metadata for the current artifact
Get version alias for the current artifact version
Get the time at which artifact was created
Get the information about when the artifact was updated
ArtifactVersionDownloadInfo
Module:ml.artifact
ArtifactVersionInternalMetadata
Module:ml.artifact
BlobStorageDirectory
Module:ml.artifact
BoundingBox
Module:ml.types
BoundingBoxGroups
Module:ml.types
ClassGroups
Module:ml.types
Config
Module:ml.types
DataDirectory
Module:ml.dataset
Get the name of the DataDirectory
Get fqn of the DataDirectory
Get storage_root of the DataDirectory
Get description of the DataDirectory
Get metadata for the current DataDirectory
Get the time at which DataDirectory was created
Get the information about when the DataDirectory was updated
DataDirectoryPath
Module:ml.dataset
EnumMissingMixin
Module:ml.enums
FastAIFramework
FastAI model Framework Module:ml.model_framework
FastAI model Framework
FileInfo
Module:ml.entities
GitInfo
Module:ml.git_info
GluonFramework
Gluon model Framework Module:ml.model_framework
Gluon model Framework
H2OFramework
H2O model Framework Module:ml.model_framework
H2O model Framework
Image
Module:ml.image
ImageRunLogType
Module:ml.image
ImageVersionInternalMetadata
Module:ml.image
InferMethodName
Name of the inference method for model serving Module:ml._autogen.client.models
Inference method name
Iterator
An iterator that yields items one at a time Module:typing
Iterator type for collections
KerasFramework
Keras model Framework Module:ml.model_framework
Keras model Framework
LibraryName
Name of a library dependency Module:ml._autogen.entities.artifacts
Library name for dependencies
LightGBMFramework
LightGBM model Framework Module:ml.model_framework
LightGBM model Framework
Metric
Module:ml.entities
MlFoundry
MlFoundry Module:ml.mlfoundry_api
MlFoundry.
MlFoundryArtifactsRepository
Module:ml.truefoundry_artifact_repo
MlFoundryException
Module:ml.exceptions
Union, One Of:
MlFoundryRun
MlFoundryRun Module:ml.mlfoundry_run
MlFoundryRun.
Get run_id for the current
runGet run_name for the current
runGet fqn for the current
run🔗 RunStatusGet status for the current
runGet ml_repo name of which the current
run is part ofTells whether automatic end for
run is True or FalseGet Mlfoundry dashboard link for a
runMLFoundryServerApiClient
Module:ml.session
MLFoundrySession
Module:ml.session
Union, One Of:
MLRepo
A repository for ML training runs and versioned entities Module:ml._autogen.entities.artifacts
MLRepo is a repository ML training runs that log params, metrics, plots, images and versioned entities like artifacts, models, prompts, tools, agents
ModelFrameworkType
Base class for all model framework implementations Module:ml.model_framework
Base class for model framework types
ModelVersion
Module:ml.model
Get the name of the model
Get fqn of the model
Get version information of the model
Get fqn of the current model version
Get the step in which model was created
Get description of the model
Get metadata for the current model
Get version alias for the current model version
🔗 ModelVersionEnvironmentGet the environment details for the model
Get the framework of the model
Get the time at which model version was created
Get the information about when the model version was updated
ModelVersionDownloadInfo
Module:ml.model
ModelVersionEnvironment
Environment configuration for model deployment Module:ml._autogen.client.models
Environment for model version
ModelVersionInternalMetadata
Module:ml.model
NonEmptyString
Module:ml.utils
Union, One Of:
NumpyEncoder
Special json encoder for numpy types Module:ml.run_utils
Special json encoder for numpy types
Union, One Of:
ONNXFramework
ONNX model Framework Module:ml.model_framework
ONNX model Framework
PaddleFramework
Paddle model Framework Module:ml.model_framework
Paddle model Framework
Plot
Module:ml.plot
PlotArtifact
Module:ml.plot
PlotRunLogType
Module:ml.plot
PlotVersionInternalMetadata
Module:ml.plot
Position
Module:ml.types
PydanticBase
Module:ml.pydantic_base
Union, One Of:
PyTorchFramework
PyTorch model Framework Module:ml.model_framework
PyTorch model Framework
SklearnFramework
Sklearn model Framework Module:ml.model_framework
Sklearn model Framework
SklearnModelSchema
Schema definition for scikit-learn model serialization Module:ml._autogen.client.models
Schema for scikit-learn models
SpaCyFramework
SpaCy model Framework Module:ml.model_framework
SpaCy model Framework
StatsModelsFramework
StatsModels model Framework Module:ml.model_framework
StatsModels model Framework
TensorFlowFramework
TensorFlow model Framework Module:ml.model_framework
TensorFlow model Framework
TransformersFramework
Transformers model Framework Module:ml.model_framework
Transformers model Framework
XGBoostFramework
XGBoost model Framework Module:ml.model_framework
XGBoost model Framework
XGBoostModelSchema
Schema definition for XGBoost model serialization Module:ml._autogen.client.models
Schema for XGBoost models