Skip to content

Commit f4d6e8d

Browse files
Update mlflow docs.
Co-authored-by: Praveen Jayachandran <[email protected]> Signed-off-by: Dushyant Behl <[email protected]> Signed-off-by: Dushyant Behl <[email protected]>
1 parent f2067da commit f4d6e8d

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -823,13 +823,13 @@ For details about how you can use set a custom stopping criteria and perform cus
823823

824824
## Experiment Tracking
825825

826-
Experiment tracking in fms-hf-tuning allows users to track their experiments with known trackers like [Aimstack](https://aimstack.io/), [MLflow](https://mlflow.org/) or custom trackers built into the code like
826+
Experiment tracking in fms-hf-tuning allows users to track their experiments with known trackers like [Aimstack](https://aimstack.io/), [MLflow Tracking](https://mlflow.org/docs/latest/tracking.html) or custom trackers built into the code like
827827
[FileLoggingTracker](./tuning/trackers/filelogging_tracker.py)
828828

829829
The code supports currently two trackers out of the box,
830830
* `FileLoggingTracker` : A built in tracker which supports logging training loss to a file.
831831
* `Aimstack` : A popular opensource tracker which can be used to track any metrics or metadata from the experiments.
832-
* `MLflow` : Another popular opensource tracker which stores metrics, metadata or even artifacts from experiments.
832+
* `MLflow Tracking` : Another popular opensource tracker which stores metrics, metadata or even artifacts from experiments.
833833

834834
Further details on enabling and using the trackers mentioned above can be found [here](docs/experiment-tracking.md).
835835

docs/experiment-tracking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ See [AimConfig](https://github.com/foundation-model-stack/fms-hf-tuning/blob/a9b
117117

118118
## MLflow Tracker
119119

120-
To enable [MLflow](https://mlflow.org/) users need to pass `"mlflow"` as the requested tracker as part of the [training argument](https://github.com/foundation-model-stack/fms-hf-tuning/blob/a9b8ec8d1d50211873e63fa4641054f704be8712/tuning/config/configs.py#L131).
120+
To enable [MLflow Tracking](https://mlflow.org/docs/latest/tracking.html) users need to pass `"mlflow"` as the requested tracker as part of the [training argument](https://github.com/foundation-model-stack/fms-hf-tuning/blob/a9b8ec8d1d50211873e63fa4641054f704be8712/tuning/config/configs.py#L131).
121121

122122

123123
When using MLflow, users need to specify additional arguments which specify [mlflow tracking uri](https://mlflow.org/docs/latest/tracking.html#common-setups) location where either a [mlflow supported database](https://mlflow.org/docs/latest/tracking/backend-stores.html#supported-store-types) or [mlflow remote tracking server](https://mlflow.org/docs/latest/tracking/server.html) is running.

tuning/trackers/tracker_factory.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ def _get_tracker_class(T, C):
4646
def _is_tracker_installed(name):
4747
if name == "aim":
4848
return _is_aim_available
49+
if name == "mlflow":
50+
return _is_mlflow_available
4951
return False
5052

5153

0 commit comments

Comments
 (0)