star

venv/lib/python3.9/site-packages/mlflow/tracking/context/abstract_context.py

@@ -0,0 +1,35 @@
+from abc import ABCMeta, abstractmethod
+
+from mlflow.utils.annotations import developer_stable
+
+
+@developer_stable
+class RunContextProvider:
+    """
+    Abstract base class for context provider objects specifying custom tags at run-creation time
+    (e.g. tags specifying the git repo with which the run is associated).
+
+    When a run is created via the fluent ``mlflow.start_run`` method, MLflow iterates through all
+    registered RunContextProviders. For each context provider where ``in_context`` returns ``True``,
+    MLflow calls the ``tags`` method on the context provider to compute context tags for the run.
+    All context tags are then merged together and set on the newly-created run.
+    """
+
+    __metaclass__ = ABCMeta
+
+    @abstractmethod
+    def in_context(self):
+        """Determine if MLflow is running in this context.
+
+        Returns:
+            bool indicating if in this context.
+
+        """
+
+    @abstractmethod
+    def tags(self):
+        """Generate context-specific tags.
+
+        Returns:
+            dict of tags.
+        """