_InternalNamespace
Module:ml.internal_namespace
_ModelFramework
Module:ml.model_framework
ModelFrameworkType
required
_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
Optional[uuid.UUID]
Optional[str]
Optional[str]
ArtifactPath
Module:ml.artifact
str
required
Optional[str]
ArtifactVersion
Module:ml.artifact
str
required
Get the name of the artifact
str
required
Get fqn of the artifact
int
required
Get version information of the artifact
str
required
Get fqn of the current artifact version
Optional[int]
required
Get the step in which artifact was created
str
required
Get description of the artifact
Dict[str, Any]
required
Get metadata for the current artifact
Optional[str]
required
Get version alias for the current artifact version
Optional[datetime.datetime]
required
Get the time at which artifact was created
Optional[datetime.datetime]
required
Get the information about when the artifact was updated
ArtifactVersionDownloadInfo
Module:ml.artifact
str
required
ArtifactVersionInternalMetadata
Module:ml.artifact
str
required
BlobStorageDirectory
Module:ml.artifact
StrictStr
required
BoundingBox
Module:ml.types
Position
required
NonEmptyStr
required
Optional[str]
BoundingBoxGroups
Module:ml.types
Dict[Group, List[BoundingBox]]
required
ClassGroups
Module:ml.types
Dict[Group, List[NonEmptyStr]]
required
Config
Module:ml.types
DataDirectory
Module:ml.dataset
str
required
Get the name of the DataDirectory
str
required
Get fqn of the DataDirectory
str
required
Get storage_root of the DataDirectory
Optional[str]
required
Get description of the DataDirectory
Dict[str, Any]
required
Get metadata for the current DataDirectory
datetime.datetime
required
Get the time at which DataDirectory was created
datetime.datetime
required
Get the information about when the DataDirectory was updated
DataDirectoryPath
Module:ml.dataset
str
required
Optional[str]
EnumMissingMixin
Module:ml.enums
FastAIFramework
FastAI model Framework Module:ml.model_framework
FastAI model Framework
Literal[Any]
default:"fastai"
required
FileInfo
Module:ml.entities
StrictStr
required
StrictBool
required
Optional[StrictInt]
Optional[StrictStr]
GitInfo
Module:ml.git_info
str
required
str
required
Optional[str]
required
str
required
bool
required
GluonFramework
Gluon model Framework Module:ml.model_framework
Gluon model Framework
Literal[Any]
default:"gluon"
required
H2OFramework
H2O model Framework Module:ml.model_framework
H2O model Framework
Literal[Any]
default:"h2o"
required
Image
Module:ml.image
Any
required
Optional[str]
required
Optional[ClassGroups]
required
Optional[BoundingBoxGroups]
required
ImageRunLogType
Module:ml.image
Dict[str, Any]
required
ImageVersionInternalMetadata
Module:ml.image
str
required
str
required
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
Literal[Any]
default:"keras"
required
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
Literal[Any]
default:"lightgbm"
required
Metric
Module:ml.entities
StrictStr
required
Optional[Union[StrictFloat, StrictInt]]
Optional[StrictInt]
Optional[StrictInt]
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.
str
required
Get run_id for the current
runstr
required
Get run_name for the current
runstr
required
Get fqn for the current
runRunStatus
required
🔗 RunStatusGet status for the current
runstr
required
Get ml_repo name of which the current
run is part ofbool
required
Tells whether automatic end for
run is True or Falsestr
required
Get Mlfoundry dashboard link for a
runMLFoundryServerApiClient
Module:ml.session
str
required
str
required
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
str
required
Get the name of the model
str
required
Get fqn of the model
int
required
Get version information of the model
str
required
Get fqn of the current model version
Optional[int]
required
Get the step in which model was created
str
required
Get description of the model
Dict[str, Any]
required
Get metadata for the current model
Optional[str]
required
Get version alias for the current model version
Optional[ModelVersionEnvironment]
required
🔗 ModelVersionEnvironmentGet the environment details for the model
Optional[Any]
required
Get the framework of the model
Optional[datetime.datetime]
required
Get the time at which model version was created
Optional[datetime.datetime]
required
Get the information about when the model version was updated
ModelVersionDownloadInfo
Module:ml.model
str
required
str
required
ModelFramework
default:"ModelFramework.UNKNOWN"
required
Optional[str]
ModelVersionEnvironment
Environment configuration for model deployment Module:ml._autogen.client.models
Environment for model version
ModelVersionInternalMetadata
Module:ml.model
str
required
str
required
bool
required
ModelFramework
default:"ModelFramework.UNKNOWN"
required
Optional[str]
Optional[str]
Optional[str]
Optional[str]
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
Literal[Any]
default:"onnx"
required
PaddleFramework
Paddle model Framework Module:ml.model_framework
Paddle model Framework
Literal[Any]
default:"paddle"
required
Plot
Module:ml.plot
PlotArtifact
Module:ml.plot
str
required
PlotRunLogType
Module:ml.plot
PlotArtifact
required
PlotVersionInternalMetadata
Module:ml.plot
str
required
Position
Module:ml.types
float
required
float
required
float
required
float
required
PydanticBase
Module:ml.pydantic_base
Union, One Of:
PyTorchFramework
PyTorch model Framework Module:ml.model_framework
PyTorch model Framework
Literal[Any]
default:"pytorch"
required
SklearnFramework
Sklearn model Framework Module:ml.model_framework
Sklearn model Framework
Literal[Any]
default:"sklearn"
required
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
Literal[Any]
default:"spacy"
required
StatsModelsFramework
StatsModels model Framework Module:ml.model_framework
StatsModels model Framework
Literal[Any]
default:"statsmodels"
required
TensorFlowFramework
TensorFlow model Framework Module:ml.model_framework
TensorFlow model Framework
Literal[Any]
default:"tensorflow"
required
TransformersFramework
Transformers model Framework Module:ml.model_framework
Transformers model Framework
Literal[Any]
default:"transformers"
required
XGBoostFramework
XGBoost model Framework Module:ml.model_framework
XGBoost model Framework
Literal[Any]
default:"xgboost"
required
XGBoostModelSchema
Schema definition for XGBoost model serialization Module:ml._autogen.client.models
Schema for XGBoost models