aidevelopementtoolkit.logging_utils.mlflow_utils
start_mlflow_run(experiment_name: str, mlflow_kwargs: Dict[str, Any]) -> None
This function starts an MLflow run with the specified experiment name and additional keyword arguments.
Notes
The function checks for the presence of the MLFLOW_ENDPOINT_URL environment variable.
If the provided MLflow tracking URI is a remote server (i.e., starts with "http"), it also checks
for the presence of the following environment variables:
- REQUESTS_CA_BUNDLE
- MLFLOW_TRACKING_USERNAME
- MLFLOW_TRACKING_PASSWORD
- MLFLOW_TRACKING_SERVER_CERT_PATH
- MLFLOW_ENDPOINT_URL
- MLFLOW_S3_ENDPOINT_URL
If you are using a local MLflow server (i.e., the tracking URI starts with "sqlite:///"), the function will create an artifacts directory in the same location as the SQLite database.
| Parameters: |
|
|---|
Examples:
>>> os.environ["MLFLOW_ENDPOINT_URL"] = https://myremote.com
>>> start_mlflow_run(
... experiment_name="MNIST",
... mlflow_kwargs={
... "run_name": "ResNet50",
... "tags": {
... "model": "resnet50",
... "pre-trained": "false",
... },
... "log_system_metrics": True,
... "description": "Simple showcase."
... }
... )
See Also
mlflow.start_run : https://mlflow.org/docs/latest/python_api/mlflow.html#mlflow.start_run
Source code in aidevelopementtoolkit/logging_utils/mlflow_utils.py
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 | |
log_run_parameters(parameters: Dict[str, Any], prefix: str = '', recursive_logging: bool = False) -> None
Logs a dictionary (including nested dictionaries) to MLFlow as parameters.
By default, all key-value pairs are logged directly. If a value is a dictionary, it is logged recursively using nested key prefixes.
| Parameters: |
|
|---|
Examples:
>>> log_run_parameters({"lr": 0.001, "batch_size": 32})
>>> log_run_parameters({"train": {"lr": 0.001}}, prefix="model")
Source code in aidevelopementtoolkit/logging_utils/mlflow_utils.py
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | |
save_model_checkpoint(model: nn.Module, config: Dict[str, Any], checkpoint_name: str) -> None
This function saves the model checkpoints to a temporary local directory and logs that directory as an artifact to MLflow.
| Parameters: |
|
|---|
Examples:
>>> save_model_checkpoint(model, {"hidden_dim": 128}, "best")
Source code in aidevelopementtoolkit/logging_utils/mlflow_utils.py
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 | |
is_numeric(val: Any) -> bool
This function checks whether a given variable is numeric.
| Parameters: |
|
|---|
| Returns: |
|
|---|
Source code in aidevelopementtoolkit/logging_utils/mlflow_utils.py
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |