Skip to content

Commit ae67ef5

Browse files
committed
Rewrite the lanbkin SDK readme
Signed-off-by: Maria Teresa Ortega <teresa.ortega0903@gmail.com>
1 parent 336cf3e commit ae67ef5

1 file changed

Lines changed: 17 additions & 13 deletions

File tree

src/lambkin/README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The LAMBKIN Python SDK is the core library for building SLAM evaluation pipeline
44

55
## Structure
66

7-
A benchmark is structured around three stages that LAMBKIN sequences, parallelizes, and keeps organized:
7+
A benchmark is structured around three stages that LAMBKIN sequences and keeps organized:
88

99
1. **Ingestion** — locate or download datasets and prepare inputs.
1010
2. **Execution** — launch and supervise the processes that run your algorithm.
@@ -22,11 +22,27 @@ results/
2222
└── ...
2323
```
2424

25+
## Requirements
26+
27+
- Python 3.10+
28+
- [`uv`](https://github.com/astral-sh/uv)
29+
30+
## Installation
31+
32+
```bash
33+
git clone git@github.com:Ekumen-OS/lambkin.git
34+
uv sync
35+
```
36+
37+
2538
## Usage
2639

2740
A benchmark is a decorated Python function. The `@lambkin.benchmark` decorator handles iteration, parameter expansion, and context setup.
2841
Inputs and outputs are registered as hooks on the benchmark function.
2942

43+
### The shell proxy
44+
`ctx.shell` exposes the host environment's executables as Python attributes. Accessing `ctx.shell.my_tool` returns a callable that, when invoked, runs `my_tool` with the given arguments. This lets benchmark scripts call external processes as if they were native Python functions, without hardcoding paths or constructing subprocess calls manually.
45+
3046
```python
3147
import lambkin
3248

@@ -58,15 +74,3 @@ def dataset(ctx):
5874
> Background process orchestration will be implemented in subsequent phases.
5975
6076
For a complete, working example using the Beluga algorithm, see [`Beluga Example`](examples/beluga/beluga_benchmark.py).
61-
62-
## Requirements
63-
64-
- Python 3.10+
65-
- [`uv`](https://github.com/astral-sh/uv)
66-
67-
## Installation
68-
69-
```bash
70-
git clone git@github.com:Ekumen-OS/lambkin.git
71-
uv sync
72-
```

0 commit comments

Comments
 (0)