ilulab 0.0.2__tar.gz

ilulab-0.0.2/.gitignore

@@ -0,0 +1,52 @@
+# Python
+__pycache__/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+.venv/
+venv/
+ENV/
+env/
+
+# Node
+node_modules/
+.next/
+out/
+.env*.local
+
+# Database
+*.db
+*.sqlite
+postgres-data/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log

ilulab-0.0.2/.pypirc.example

@@ -0,0 +1,13 @@
+[distutils]
+index-servers =
+    pypi
+    testpypi
+
+[pypi]
+username = __token__
+password = <your-token-here>
+
+[testpypi]
+repository = https://test.pypi.org/legacy/
+username = __token__
+password = <your-token-here>

ilulab-0.0.2/DEVELOP.md

@@ -0,0 +1,68 @@
+# Development Setup
+
+## Installation
+
+For local development:
+
+```bash
+uv sync --frozen --extra dev
+```
+
+## Testing in another project
+
+To test the package in another project without publishing to PyPI, you can use `uv add` to install
+
+```bash
+cd ~
+git clone git@github.com:pascal-pfeiffer/ilulab-client.git
+
+# From another project directory:
+uv add ~/ilulab-client
+```
+
+### Upload to PyPI
+
+#### Create PyPI accounts and API tokens
+
+You'll need to create accounts and generate API tokens:
+
+- TestPyPI (for testing): <https://test.pypi.org/account/register/>
+- PyPI (production): <https://pypi.org/account/register/>
+
+For each, go to Account Settings → API tokens → Add API token. Create tokens scoped to "Entire account" initially (you can scope to specific project after first upload).
+
+#### Store tokens securely
+
+Create a ~/.pypirc file (NOT in the repo):
+
+```sh
+cp .pypirc.example ~/.pypirc
+```
+
+And add your tokens. Then secure it:
+
+```sh
+chmod 600 ~/.pypirc
+```
+
+#### Test on TestPyPI first
+
+Once you have the token, run:
+
+```bash
+make publish-test
+```
+
+Then test installation:
+
+```bash
+pip install --index-url https://test.pypi.org/simple/ ilulab
+```
+
+#### Upload to real PyPI
+
+If TestPyPI works:
+
+```bash
+uv run python -m twine upload dist/*
+```

ilulab-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 IluLab contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ilulab-0.0.2/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-include examples *.py

ilulab-0.0.2/Makefile

@@ -0,0 +1,36 @@
+.PHONY: clean
+clean:
+	rm -rf dist/ build/ *.egg-info/ .venv/ .mypy_cache/ .pytest_cache/ .ruff_cache/
+	find . -type d -name __pycache__ -exec rm -rf {} +
+
+.PHONY: build
+build: clean
+	uv run --frozen --extra dev python -m build
+
+.PHONY: publish-test
+publish-test: build
+	uv run --frozen --extra dev python -m twine upload --repository testpypi dist/* --verbose
+
+.PHONY: publish
+publish: build
+	uv run --frozen --extra dev python -m twine upload dist/*
+
+.PHONY: lint
+lint:
+	uv run --frozen --extra dev ruff check .
+
+.PHONY: format
+format:
+	uv run --frozen --extra dev ruff format .
+	uv run --frozen --extra dev ruff check --fix .
+
+.PHONY: typecheck
+typecheck:
+	uv run --frozen --extra dev ty check ilulab
+
+.PHONY: check
+check: lint typecheck
+
+.PHONY: test
+test:
+	uv run --frozen --extra dev pytest tests/

ilulab-0.0.2/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: ilulab
+Version: 0.0.2
+Summary: Lightweight Python client for IluLab
+Author: ilulab contributors
+License: MIT
+License-File: LICENSE
+Keywords: experiment-tracking,logging,machine-learning,mlops
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.14.7; extra == 'dev'
+Requires-Dist: twine>=5.0.0; extra == 'dev'
+Requires-Dist: ty>=0.0.1a29; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# IluLab Python Client
+
+Lightweight Python client for tracking ML experiments with IluLab.
+
+## Installation
+
+```bash
+pip install ilulab
+```
+
+## Quick Start
+
+Set your API token as an environment variable:
+
+```bash
+export ILULAB_TOKEN="your_api_token_here"
+```
+
+then use the client in your code:
+
+```python
+from ilulab import IlulabClient
+
+# Initialize client
+client = IlulabClient()
+
+# Create a project
+project = client.create_project(
+    name="my-ml-project",
+    description="Testing ilulab"
+)
+
+# Create a run
+run = client.create_run(
+    project_id=project["id"],
+    name="experiment-1",
+    tags=["baseline", "resnet"]
+)
+
+# Log parameters
+run.log_params({
+    "batch_size": 32,
+    "optimizer": "adam",
+    "model": "resnet50"
+})
+
+# Log metrics during training
+for epoch in range(10):
+    # ... training code ...
+    loss = 0.5 - epoch * 0.03  # example
+    accuracy = 0.6 + epoch * 0.04  # example
+
+    run.log_metrics({
+        "train_loss": loss,
+        "train_accuracy": accuracy
+    }, step=epoch)
+
+# Mark run as completed
+run.finish()
+
+# Clean up
+client.close()
+```
+
+## Using Context Managers
+
+```python
+from ilulab import IlulabClient
+
+with IlulabClient() as client:
+    project = client.create_project(name="my-project")
+
+    with client.create_run(project["id"], name="experiment-1") as run:
+        run.log_param("learning_rate", 0.001)
+
+        for step in range(100):
+            run.log_metric("loss", 1.0 / (step + 1), step=step)
+
+        # Automatically marked as completed on exit
+        # (or failed if an exception occurs)
+```

ilulab-0.0.2/README.md

@@ -0,0 +1,81 @@
+# IluLab Python Client
+
+Lightweight Python client for tracking ML experiments with IluLab.
+
+## Installation
+
+```bash
+pip install ilulab
+```
+
+## Quick Start
+
+Set your API token as an environment variable:
+
+```bash
+export ILULAB_TOKEN="your_api_token_here"
+```
+
+then use the client in your code:
+
+```python
+from ilulab import IlulabClient
+
+# Initialize client
+client = IlulabClient()
+
+# Create a project
+project = client.create_project(
+    name="my-ml-project",
+    description="Testing ilulab"
+)
+
+# Create a run
+run = client.create_run(
+    project_id=project["id"],
+    name="experiment-1",
+    tags=["baseline", "resnet"]
+)
+
+# Log parameters
+run.log_params({
+    "batch_size": 32,
+    "optimizer": "adam",
+    "model": "resnet50"
+})
+
+# Log metrics during training
+for epoch in range(10):
+    # ... training code ...
+    loss = 0.5 - epoch * 0.03  # example
+    accuracy = 0.6 + epoch * 0.04  # example
+
+    run.log_metrics({
+        "train_loss": loss,
+        "train_accuracy": accuracy
+    }, step=epoch)
+
+# Mark run as completed
+run.finish()
+
+# Clean up
+client.close()
+```
+
+## Using Context Managers
+
+```python
+from ilulab import IlulabClient
+
+with IlulabClient() as client:
+    project = client.create_project(name="my-project")
+
+    with client.create_run(project["id"], name="experiment-1") as run:
+        run.log_param("learning_rate", 0.001)
+
+        for step in range(100):
+            run.log_metric("loss", 1.0 / (step + 1), step=step)
+
+        # Automatically marked as completed on exit
+        # (or failed if an exception occurs)
+```

ilulab-0.0.2/examples/simple_example.py

@@ -0,0 +1,71 @@
+"""Simple example showing how to use ilulab client."""
+
+from ilulab import IlulabClient
+
+
+def main():
+    # Initialize client
+    client = IlulabClient()
+
+    # Create a project
+    project = client.create_project(name="example-project", description="A simple example project")
+    print(f"Created project: {project['name']} ({project['id']})")
+
+    # Create a run with tags
+    run = client.create_run(
+        project_id=project["id"],
+        name="example-run-1",
+        description="Testing the ilulab client",
+        tags=["example", "test"],
+    )
+    print(f"Created run: {run.run_id}")
+
+    # Log parameters (hyperparameters, config)
+    run.log_params(
+        {
+            "batch_size": 32,
+            "optimizer": "adam",
+            "model_architecture": "resnet50",
+        }
+    )
+    print("Logged parameters")
+
+    # Simulate a training loop
+    print("\nSimulating training loop...")
+    for epoch in range(10):
+        # Simulate metrics
+        train_loss = 1.0 / (epoch + 1)
+        val_loss = 1.2 / (epoch + 1)
+        val_acc = 0.5 + epoch * 0.05
+
+        # Log metrics for this step
+        run.log_metrics(
+            {"train_loss": train_loss, "val_loss": val_loss, "val_accuracy": val_acc},
+            step=epoch,
+        )
+
+        print(
+            f"{epoch + 1}/10: train_loss={train_loss:.4f}, "
+            "val_loss={val_loss:.4f}, val_accuracy={val_acc:.4f}"
+        )
+
+    # Mark run as completed
+    run.finish()
+    print("\nRun completed!")
+
+    # Retrieve run data
+    run_data = client.get_run(run.run_id)
+    print(
+        f"\nRun has {len(run_data['parameters'])} parameters and {len(run_data['metrics'])} metrics"
+    )
+
+    # List all runs in the project
+    runs = client.list_runs(project_id=project["id"])
+    print(f"\nTotal runs in project: {len(runs)}")
+
+    # Clean up
+    client.close()
+
+
+if __name__ == "__main__":
+    main()

ilulab-0.0.2/ilulab/__init__.py

@@ -0,0 +1,6 @@
+"""ilulab - Lightweight ML experiment tracking client."""
+
+from ilulab.client import IlulabClient, Run
+
+__version__ = "0.0.2"
+__all__ = ["IlulabClient", "Run"]