Rename start to setup (#69)

Signed-off-by: kerthcet <kerthcet@gmail.com>

Author: kerthcet

README.md

@@ -45,17 +45,18 @@ Run the following command for setup:
 cp .env.example .env & make up
 ```
 
-You can login to pgAdmin at `http://localhost:8080` to see the Postgres database. The host name for registering a new server is `postgres`, and the username and password are `alphatrion` and `alphatr1on`, respectively.
+You can login to pgAdmin at `http://localhost:8080` to see the Postgres database with following credentials:
 
-**Note:**  
-To log in to the pgAdmin web interface itself (before adding a server),  
-use the default credentials defined in `docker-compose.yaml`:  
-**Email:** `alphatrion@inftyai.com`  
-**Password:** `alphatr1on`
+```shell
+Email:     alphatrion@inftyai.com
+Username:  alphatrion
+Password:  alphatr1on
+Server:    postgres
+```
 
 ### Run a Sample Experiment
 
-Below is a simple example demonstrating how to create an experiment and log performance metrics.
+Below is a simple example with two approaches demonstrating how to create an experiment and log performance metrics.
 
 ```python
 import alphatrion as alpha
@@ -68,8 +69,8 @@ async def report():
   # Run your code here then log metrics.
   await alpha.log_metrics({"accuracy": 0.95})
 
-async with alpha.CraftExperiment.start(name="my_first_experiment") as exp:
-  async with exp.start_trial(name="my_first_trial") as trial:
+async with alpha.CraftExperiment.setup(name="my_first_experiment") as exp:
+  async with exp.start_trial(name="my_trial") as trial:
     run = trial.start_run(lambda: report())
     await run.wait()
 ```

alphatrion/experiment/base.py

@@ -29,7 +29,7 @@ def get_trial(self, id: int) -> trial.Trial | None:
 
     async def __aenter__(self):
         if self._id is None:
-            raise RuntimeError("Experiment is not set. Did you call run()?")
+            raise RuntimeError("Experiment is not set. Did you call start()?")
 
         exp = self._get()
         if exp is None:
@@ -43,7 +43,7 @@ async def __aexit__(self, exc_type, exc_val, exc_tb):
 
     @classmethod
     @abstractmethod
-    def start(
+    def setup(
         cls, name: str, description: str | None = None, meta: dict | None = None
     ) -> "Experiment":
         """Return a new experiment."""

alphatrion/experiment/craft_exp.py

@@ -14,14 +14,14 @@ def __init__(self):
         super().__init__()
 
     @classmethod
-    def start(
+    def setup(
         cls,
         name: str,
         description: str | None = None,
         meta: dict | None = None,
     ) -> "CraftExperiment":
         """
-        Begin the experiment. If the name already exists in the same project,
+        Setup the experiment. If the name already exists in the same project,
         it will refer to the existing experiment instead of creating a new one.
         """
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "alphatrion"
-version = "0.0.1"
+version = "0.0.2"
 description = "AlphaTrion is an open-source and all-in-one platform to build AI-powered applications."
 license = {text = "Apache-2.0"}
 readme = "README.md"

tests/integration/test_log.py

@@ -16,7 +16,7 @@
 async def test_log_artifact():
     alpha.init(project_id=uuid.uuid4(), artifact_insecure=True, init_tables=True)
 
-    async with alpha.CraftExperiment.start(
+    async with alpha.CraftExperiment.setup(
         name="log_artifact_exp",
         description="Context manager test",
         meta={"key": "value"},
@@ -68,7 +68,7 @@ async def test_log_artifact():
 async def test_log_params():
     alpha.init(project_id=uuid.uuid4(), artifact_insecure=True, init_tables=True)
 
-    async with alpha.CraftExperiment.start(name="log_params_exp") as exp:
+    async with alpha.CraftExperiment.setup(name="log_params_exp") as exp:
         trial = exp.start_trial(name="first-trial", params={"param1": 0.1})
 
         new_trial = exp._runtime._metadb.get_trial(trial_id=trial.id)
@@ -98,7 +98,7 @@ async def test_log_metrics():
     async def log_metric(metrics: dict):
         await alpha.log_metrics(metrics)
 
-    async with alpha.CraftExperiment.start(name="log_metrics_exp") as exp:
+    async with alpha.CraftExperiment.setup(name="log_metrics_exp") as exp:
         trial = exp.start_trial(name="first-trial", params={"param1": 0.1})
 
         new_trial = exp._runtime._metadb.get_trial(trial_id=trial._id)
@@ -145,7 +145,7 @@ async def test_log_metrics_with_save_on_max():
     async def log_metric(value: float):
         await alpha.log_metrics({"accuracy": value})
 
-    async with alpha.CraftExperiment.start(
+    async with alpha.CraftExperiment.setup(
         name="log_metrics_with_save_on_max",
         description="Context manager test",
         meta={"key": "value"},
@@ -211,7 +211,7 @@ async def test_log_metrics_with_save_on_min():
     async def log_metric(value: float):
         await alpha.log_metrics({"accuracy": value})
 
-    async with alpha.CraftExperiment.start(
+    async with alpha.CraftExperiment.setup(
         name="log_metrics_with_save_on_min",
         description="Context manager test",
         meta={"key": "value"},
@@ -280,7 +280,7 @@ async def fake_sleep(value: float):
         await asyncio.sleep(100)
         await alpha.log_metrics({"accuracy": value})
 
-    async with alpha.CraftExperiment.start(
+    async with alpha.CraftExperiment.setup(
         name="log_metrics_with_early_stopping"
     ) as exp:
         async with exp.start_trial(
@@ -317,7 +317,7 @@ async def fake_sleep(value: float):
         await asyncio.sleep(value)
         await alpha.log_metrics({"accuracy": value})
 
-    async with alpha.CraftExperiment.start(
+    async with alpha.CraftExperiment.setup(
         name="log_metrics_with_both_early_stopping_and_timeout"
     ) as exp:
         async with exp.start_trial(
@@ -346,7 +346,7 @@ async def test_log_metrics_with_max_run_number():
     async def fake_work(value: float):
         await alpha.log_metrics({"accuracy": value})
 
-    async with alpha.CraftExperiment.start(
+    async with alpha.CraftExperiment.setup(
         name="log_metrics_with_max_run_number"
     ) as exp:
         async with exp.start_trial(

tests/integration/test_tracing.py

@@ -52,7 +52,7 @@ async def joke_workflow():
 
 @pytest.mark.asyncio
 async def test_workflow():
-    async with alpha.CraftExperiment.start("demo_joke_workflow") as exp:
+    async with alpha.CraftExperiment.setup("demo_joke_workflow") as exp:
         async with exp.start_trial("demo_joke_trial") as trial:
             task = trial.start_run(lambda: joke_workflow())
             await task.wait()

tests/unit/experiment/test_craft_exp.py

@@ -15,7 +15,7 @@
 async def test_craft_experiment():
     init(project_id=uuid.uuid4(), artifact_insecure=True, init_tables=True)
 
-    async with CraftExperiment.start(
+    async with CraftExperiment.setup(
         name="context_exp",
         description="Context manager test",
         meta={"key": "value"},
@@ -43,7 +43,7 @@ async def fake_work(trial: Trial):
         await asyncio.sleep(3)
         trial.cancel()
 
-    exp = CraftExperiment.start(name="no_context_exp")
+    exp = CraftExperiment.setup(name="no_context_exp")
     async with exp.start_trial(name="first-trial") as trial:
         trial.start_run(lambda: fake_work(trial))
         await trial.wait()
@@ -56,7 +56,7 @@ async def test_create_experiment_with_trial():
     init(project_id=uuid.uuid4(), artifact_insecure=True, init_tables=True)
 
     trial_id = None
-    async with CraftExperiment.start(name="context_exp") as exp:
+    async with CraftExperiment.setup(name="context_exp") as exp:
         async with exp.start_trial(name="first-trial") as trial:
             trial_obj = trial._get_obj()
             assert trial_obj is not None
@@ -76,7 +76,7 @@ async def fake_work(trial: Trial):
         trial.cancel()
 
     trial_id = None
-    async with CraftExperiment.start(name="context_exp") as exp:
+    async with CraftExperiment.setup(name="context_exp") as exp:
         async with exp.start_trial(name="first-trial") as trial:
             trial_id = current_trial_id.get()
             start_time = datetime.now()
@@ -100,7 +100,7 @@ async def fake_work(cancel_func: callable):
         cancel_func()
 
     async with (
-        CraftExperiment.start(name="context_exp") as exp,
+        CraftExperiment.setup(name="context_exp") as exp,
         exp.start_trial(name="first-trial") as trial,
     ):
         start_time = datetime.now()
@@ -123,7 +123,7 @@ async def fake_work(cancel_func: callable):
 async def test_craft_experiment_with_context():
     init(project_id=uuid.uuid4(), artifact_insecure=True, init_tables=True)
 
-    async with CraftExperiment.start(
+    async with CraftExperiment.setup(
         name="context_exp",
         description="Context manager test",
         meta={"key": "value"},
@@ -160,7 +160,7 @@ async def fake_work():
         trial = trial._get_obj()
         assert trial.status == TrialStatus.FINISHED
 
-    async with CraftExperiment.start(
+    async with CraftExperiment.setup(
         name="context_exp",
         description="Context manager test",
         meta={"key": "value"},