Configuration

class kedro_mlflow.config.kedro_mlflow_config.DictParamsOptions(*, flatten: StrictBool = False, recursive: StrictBool = True, sep: str = '.')

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
flatten: StrictBool
recursive: StrictBool
sep: str
class kedro_mlflow.config.kedro_mlflow_config.DisableTrackingOptions(*, pipelines: List[str] = [])

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
pipelines: List[str]
class kedro_mlflow.config.kedro_mlflow_config.ExperimentOptions(*, name: str = 'Default', restore_if_deleted: StrictBool = True)

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
name: str
restore_if_deleted: StrictBool
class kedro_mlflow.config.kedro_mlflow_config.KedroMlflowConfig(*, project_path: Path, server: MlflowServerOptions = MlflowServerOptions(mlflow_tracking_uri=None, credentials=None), tracking: MlflowTrackingOptions = MlflowTrackingOptions(disable_tracking=DisableTrackingOptions(pipelines=[]), experiment=ExperimentOptions(name='Default', restore_if_deleted=True), run=RunOptions(id=None, name=None, nested=True), params=MlflowParamsOptions(dict_params=DictParamsOptions(flatten=False, recursive=True, sep='.'), long_params_strategy='fail')), ui: UiOptions = UiOptions(port='5000', host='127.0.0.1'))

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
validate_assignment = True
project_path: Path
server: MlflowServerOptions
setup(context)

Setup all the mlflow configuration

tracking: MlflowTrackingOptions
ui: UiOptions
exception kedro_mlflow.config.kedro_mlflow_config.KedroMlflowConfigError

Bases: Exception

Error occurred when loading the configuration

class kedro_mlflow.config.kedro_mlflow_config.MlflowParamsOptions(*, dict_params: DictParamsOptions = DictParamsOptions(flatten=False, recursive=True, sep='.'), long_params_strategy: Literal['fail', 'truncate', 'tag'] = 'fail')

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
dict_params: DictParamsOptions
long_params_strategy: Literal['fail', 'truncate', 'tag']
class kedro_mlflow.config.kedro_mlflow_config.MlflowServerOptions(*, mlflow_tracking_uri: str = None, credentials: str = None)

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
credentials: Optional[str]
mlflow_tracking_uri: Optional[str]
class kedro_mlflow.config.kedro_mlflow_config.MlflowTrackingOptions(*, disable_tracking: DisableTrackingOptions = DisableTrackingOptions(pipelines=[]), experiment: ExperimentOptions = ExperimentOptions(name='Default', restore_if_deleted=True), run: RunOptions = RunOptions(id=None, name=None, nested=True), params: MlflowParamsOptions = MlflowParamsOptions(dict_params=DictParamsOptions(flatten=False, recursive=True, sep='.'), long_params_strategy='fail'))

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
disable_tracking: DisableTrackingOptions
experiment: ExperimentOptions
params: MlflowParamsOptions
run: RunOptions
class kedro_mlflow.config.kedro_mlflow_config.RunOptions(*, id: str = None, name: str = None, nested: StrictBool = True)

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
id: Optional[str]
name: Optional[str]
nested: StrictBool
class kedro_mlflow.config.kedro_mlflow_config.UiOptions(*, port: str = '5000', host: str = '127.0.0.1')

Bases: BaseModel

class Config

Bases: object

extra = 'forbid'
host: str
port: str