Urartu
Urartu is an ML workflow runner built around Pipelines (orchestrators) and Actions (reusable steps) with automatic caching and dependency injection.
Installation
pip install urartu
From source:
git clone git@github.com:tamohannes/urartu.git
cd urartu
pip install -e .
Project layout (recommended)
Run the CLI from a project root that contains:
my_project/
├── __init__.py
├── actions/
│ ├── __init__.py
│ └── my_action.py
├── pipelines/
│ ├── __init__.py
│ └── my_pipeline.py
└── configs/
└── pipeline/
└── my_pipeline.yaml
Optional (per-user configs):
my_project/
└── configs_<username>/
├── aim/
├── machine/
└── slurm/
Quickstart
Create a pipeline config:
# configs/pipeline/my_pipeline.yaml
pipeline_name: my_pipeline
debug: false
pipeline:
experiment_name: "My pipeline"
device: auto
seed: 42
# Pipeline-level cache policy (propagates to actions)
cache_enabled: true
force_rerun: false
cache_max_age_days: 7
actions:
- action_name: my_action
# Action-specific config (merged with pipeline-level common settings)
some_param: 123
Create the pipeline file:
from aim import Run
from omegaconf import DictConfig
from urartu.common import Pipeline
class MyPipeline(Pipeline):
pass
def main(cfg: DictConfig, aim_run: Run):
MyPipeline(cfg, aim_run).main()
Create an action:
from omegaconf import DictConfig
from aim import Run
from urartu.common import Action
class MyAction(Action):
def run(self):
cache_dir = self.get_cache_entry_dir()
run_dir = self.get_run_dir()
# ... compute, write machine-readable artifacts to cache_dir ...
# ... write plots/reports to run_dir ...
def get_outputs(self):
return {
"cache_dir": str(self.get_cache_entry_dir()),
"run_dir": str(self.get_run_dir()),
}
Run it:
urartu my_pipeline
CLI overrides and config groups
- Overrides:
pipeline.seed=123,pipeline.device=cuda,descr="my run". - Config-group selectors (unquoted) load
*.yamlfiles from:configs_<username>/<group>/<selector>.yamlconfigs/<group>/<selector>.yaml- built-in defaults in the Urartu package
Examples:
# Select config files (unquoted values)
urartu my_pipeline machine=local slurm=no_slurm aim=no_aim
# Set literal strings (quoted values)
urartu my_pipeline descr="experiment 001" machine="local"
Notes on outputs and caching
- Cached, machine-readable artifacts: write under
self.get_cache_entry_dir(...)(shared across runs). - Run artifacts (plots/reports/logs): write under
self.get_run_dir(...)(unique per run).
Citation
If you find Urartu helpful in your research, please cite it:
@software{Tamoyan_Urartu_2023,
author = {Hovhannes Tamoyan},
license = {Apache-2.0},
month = {8},
title = {{Urartu}},
url = {https://github.com/tamohannes/urartu},
year = {2023}
}
Metadata
Release files for urartu 5.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| urartu-5.0.4.tar.gz | 144.0 kB | Without provenance | Details for urartu-5.0.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| urartu-5.0.4-py3-none-any.whl | Python 3 | none | any | Details for urartu-5.0.4-py3-none-any.whl |
Total release size: 311.0 kB
Release files / urartu-5.0.4.tar.gz
| Download URL | urartu-5.0.4.tar.gz |
|---|---|
| Size | 144.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f56288a96fd52d1c717eb7b90058749a81d234959e28375fa34047e68b5507ef
|
|
BLAKE2b-256 checksum How to use checksums |
b1224ec768722c464cda3ccb2aa9bfad0064edb4569d49862d719a3f80a74900
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Release files / urartu-5.0.4-py3-none-any.whl
| Download URL | urartu-5.0.4-py3-none-any.whl |
|---|---|
| Size | 167.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1f9a16d6ccf238975525881a817aae67e81652e773978913e1632f77ce6a9207
|
|
BLAKE2b-256 checksum How to use checksums |
848f8b4266c8a9b724cd3e18e59ffe513cefa8cdc09694d672311ec06a614a12
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.2
|
Security for urartu 5.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.