Add support for log_params (#25)

* Defiine the public APIs

Signed-off-by: kerthcet <[email protected]>

* Move labels to meta

Signed-off-by: kerthcet <[email protected]>

* Add support to log params

Signed-off-by: kerthcet <[email protected]>

---------

Signed-off-by: kerthcet <[email protected]>

Author: kerthcet

alphatrion/__init__.py

@@ -1,3 +1,5 @@
-from alphatrion.experiment.craft_exp import CraftExperiment as CraftExperiment
-from alphatrion.observe.observe import log_artifact as log_artifact
-from alphatrion.runtime.runtime import init as init
+from alphatrion.experiment.craft_exp import CraftExperiment
+from alphatrion.observe.observe import log_artifact, log_params
+from alphatrion.runtime.runtime import init
+
+__all__ = ["log_artifact", "log_params", "CraftExperiment", "init"]

alphatrion/experiment/base.py

@@ -97,15 +97,13 @@ def run(
         name: str | None = None,
         description: str | None = None,
         meta: dict | None = None,
-        labels: dict | None = None,
     ):
         """
         :param project_id: the project ID to run the experiment under
         :param name: the name of the experiment. If not provided,
             a UUID will be generated.
         :param description: the description of the experiment
         :param meta: the metadata of the experiment
-        :param labels: the labels of the experiment
         :param artifact_insecure: whether to use insecure connection to the
             artifact registry. Default is False.
 
@@ -114,15 +112,17 @@ def run(
 
         exp = Experiment(config=config)
         return RunContext(
-            exp, name=name, description=description, meta=meta, labels=labels
+            exp,
+            name=name,
+            description=description,
+            meta=meta,
         )
 
     def create(
         self,
         name: str,
         description: str | None = None,
         meta: dict | None = None,
-        labels: dict | None = None,
         status: ExperimentStatus = ExperimentStatus.PENDING,
     ) -> int:
         """
@@ -135,7 +135,6 @@ def create(
             description=description,
             project_id=self._runtime._project_id,
             meta=meta,
-            labels=labels,
             status=status,
         )
 
@@ -162,24 +161,29 @@ def delete(self, exp_id: int):
         self._runtime._metadb.delete_exp(exp_id=exp_id)
         self._artifact.delete(experiment_name=exp.name, versions=tags)
 
-    # Please provide all the labels to update, or it will overwrite the existing labels.
-    def update_labels(self, exp_id: int, labels: dict):
-        self._runtime._metadb.update_exp(exp_id=exp_id, labels=labels)
+    # Please provide all the tags to update, or it will overwrite the existing tags.
+    def update_tags(self, exp_id: int, tags: dict):
+        exp = self.get(exp_id)
+        if exp is None:
+            return
+
+        if exp.meta is None:
+            exp.meta = {}
+
+        exp.meta["tags"] = tags
+        self._runtime._metadb.update_exp(exp_id=exp_id, meta=exp.meta)
 
-    # start with save the
     def _start(
         self,
         name: str | None = None,
         description: str | None = None,
         meta: dict | None = None,
-        labels: dict | None = None,
     ) -> int:
         """
         :param name: the name of the experiment. If not provided,
             a UUID will be generated.
         :param description: the description of the experiment
         :param meta: the metadata of the experiment
-        :param labels: the labels of the experiment
 
         :return: the experiment ID
         """
@@ -191,8 +195,7 @@ def _start(
             name=name,
             description=description,
             meta=meta,
-            labels=labels,
-            status=ExperimentStatus.RUNNING
+            status=ExperimentStatus.RUNNING,
         )
 
         return exp_id
@@ -226,20 +229,17 @@ def __init__(
         name: str | None = None,
         description: str | None = None,
         meta: dict | None = None,
-        labels: dict | None = None,
     ):
         self._experiment = experiment
         self._exp_name = name
         self._description = description
         self._meta = meta
-        self._labels = labels
 
     def __enter__(self):
         exp_id = self._experiment._start(
             name=self._exp_name,
             description=self._description,
             meta=self._meta,
-            labels=self._labels,
         )
 
         # Set the current experiment ID in the runtime

alphatrion/metadata/sql.py

@@ -21,7 +21,6 @@ def create_exp(
         project_id: str,
         description: str | None,
         meta: dict | None,
-        labels: dict | None = None,
         status: ExperimentStatus = ExperimentStatus.PENDING,
     ) -> int:
         session = self._session()
@@ -30,7 +29,6 @@ def create_exp(
             description=description,
             project_id=project_id,
             meta=meta,
-            labels=labels,
             status=status,
         )
         session.add(new_exp)
@@ -98,15 +96,13 @@ def create_model(
         version: str = "latest",
         description: str | None = None,
         meta: dict | None = None,
-        labels: dict | None = None,
     ):
         session = self._session()
         new_model = Model(
             name=name,
             version=version,
             description=description,
             meta=meta,
-            labels=labels,
         )
         session.add(new_model)
         session.commit()

alphatrion/metadata/sql_models.py

@@ -29,7 +29,9 @@ class Experiment(Base):
         Enum(ExperimentStatus), nullable=False, default=ExperimentStatus.PENDING
     )
     meta = Column(JSON, nullable=True, comment="Additional metadata for the experiment")
-    labels = Column(JSON, nullable=True, comment="Labels for the experiment")
+    # Let's start with simple approach here, it the params are too large,
+    # we can move them to a separate table.
+    params = Column(JSON, nullable=True, comment="Parameters for the experiment")
     duration = Column(Integer, default=0, comment="Duration in seconds")
 
     created_at = Column(DateTime(timezone=True), default=datetime.now(UTC))
@@ -47,10 +49,18 @@ class Model(Base):
     version = Column(String, nullable=False)
     description = Column(String, nullable=True)
     meta = Column(JSON, nullable=True, comment="Additional metadata for the model")
-    labels = Column(JSON, nullable=True, comment="Labels for the model")
 
     created_at = Column(DateTime(timezone=True), default=datetime.now(UTC))
     updated_at = Column(
         DateTime(timezone=True), default=datetime.now(UTC), onupdate=datetime.now(UTC)
     )
     is_del = Column(Integer, default=0, comment="0 for not deleted, 1 for deleted")
+
+
+class Params(Base):
+    __tablename__ = "params"
+
+    id = Column(Integer, primary_key=True)
+    experiment_id = Column(Integer, nullable=False)
+    params = Column(JSON, nullable=False, comment="Parameters for the experiment")
+    is_del = Column(Integer, default=0, comment="0 for not deleted, 1 for deleted")

alphatrion/model/model.py

@@ -10,13 +10,11 @@ def create(
         name: str,
         description: str | None = None,
         meta: dict | None = None,
-        labels: dict | None = None,
     ):
         self._runtime._metadb.create_model(
             name=name,
             description=description,
             meta=meta,
-            labels=labels,
         )
 
     def update(self, model_id: int, **kwargs):

alphatrion/observe/observe.py

@@ -35,9 +35,9 @@ def log_artifact(
     runtime._artifact.push(experiment_name=exp.name, paths=paths, version=version)
 
 
-# def log_params(exp_id: int, params: dict):
-#     runtime = global_runtime()
-#     if runtime is None:
-#         raise RuntimeError("Runtime is not initialized. Please call init() first.")
+def log_params(params: dict):
+    runtime = global_runtime()
+    if runtime is None:
+        raise RuntimeError("Runtime is not initialized. Please call init() first.")
 
-#     runtime._metadb.log_params(exp_id=exp_id, params=params)
+    runtime._metadb.update_exp(exp_id=runtime._current_exp_id, params=params)

tests/integration/artifact/test_artifact.py renamed to tests/integration/test_artifact.py

@@ -66,14 +66,13 @@ def test_push_with_folder(artifact):
         assert "v1" not in tags
 
 
-def test_save_checkpoint():
+def test_log_artifact():
     init(project_id="test_project", artifact_insecure=True)
 
     with Experiment.run(
         name="context_exp",
         description="Context manager test",
         meta={"key": "value"},
-        labels={"type": "unit"},
     ) as exp:
         with tempfile.TemporaryDirectory() as tmpdir:
             os.chdir(tmpdir)

tests/integration/test_params.py

@@ -0,0 +1,14 @@
+
+import alphatrion as at
+
+
+def test_log_params():
+    at.init(project_id="test_project", artifact_insecure=True)
+
+    with at.CraftExperiment.run(name="test_experiment") as exp:
+        params = {"param1": 0.1, "param2": "value2", "param3": 3}
+        at.log_params(params=params)
+
+        new_exp = exp._runtime._metadb.get_exp(exp_id=exp._runtime._current_exp_id)
+        assert new_exp is not None
+        assert new_exp.params == params

tests/integration/test_sdk.py

@@ -13,19 +13,18 @@ def exp():
 
 
 def test_experiment_crud(exp):
-    id = exp.create("test_exp", "A test experiment", {"foo": "bar"}, {"env": "test"})
+    id = exp.create("test_exp", "A test experiment")
     exp1 = exp.get(id)
     assert exp1 is not None
     assert exp1.name == "test_exp"
     assert exp1.description == "A test experiment"
-    assert exp1.meta == {"foo": "bar"}
     assert exp1.status == ExperimentStatus.PENDING
     assert exp1.duration == 0
     assert len(exp.list_paginated()) == 1
 
-    exp.update_labels(id, {"env": "prod"})
+    exp.update_tags(id, {"env": "prod"})
     exp1 = exp.get(id)
-    assert exp1.labels == {"env": "prod"}
+    assert exp1.meta["tags"] == {"env": "prod"}
 
 
 def test_experiment_start(exp):