Skip to content

Commit ae31849

Browse files
authored
Fix marimo usage docs (#352)
This PR updates the Marimo docs by removing unnecessary uv init/venv steps and launching directly with `uvx`, which installs dependencies on-the-fly.
1 parent b6635e4 commit ae31849

File tree

2 files changed

+3
-38
lines changed

2 files changed

+3
-38
lines changed

docs/example_notebooks.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,7 @@ The example notebooks use marimo, which provides a **sandboxed environment** tha
2525

2626
### Setup
2727

28-
**Step-1 : Add [marimo](https://github.com/marimo-team/marimo) to your project**
29-
30-
Ensure the working directory where you run `uv init` doesn't have an existing `pyproject.toml` as `uv add` will try to add marimo to the existing `.toml`.
31-
32-
```bash
33-
# move to a new dir
34-
mkdir sleap_nn_notebooks
35-
cd sleap_nn_notebooks
36-
37-
# initialize uv
38-
uv init
39-
40-
# Install marimo
41-
uv add marimo
42-
```
43-
44-
**Step-2 : Run the marimo notebooks**
45-
46-
Download the notebooks from [here](https://github.com/talmolab/sleap-nn/tree/main/example_notebooks) and ensure the python scripts are in your current working directory!
28+
Download the notebooks from [here](https://github.com/talmolab/sleap-nn/tree/main/example_notebooks)!
4729

4830
(i) Training Demo Notebook
4931

example_notebooks/README.md

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The example notebooks use marimo, which provides a **sandboxed environment** tha
1212

1313
### Prerequisites
1414

15-
**Install [uv](https://github.com/astral-sh/uv)**:
15+
**Step-1 : Install [uv](https://github.com/astral-sh/uv)**:
1616
Install [`uv`](https://github.com/astral-sh/uv) first - a fast Python package manager:
1717
```bash
1818
# macOS/Linux
@@ -22,27 +22,10 @@ Install [`uv`](https://github.com/astral-sh/uv) first - a fast Python package ma
2222
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
2323
```
2424

25-
### Setup
26-
27-
**Step-1 : Add [marimo](https://github.com/marimo-team/marimo) to your project**
28-
29-
Ensure the working directory where you run `uv init` doesn't have an existing `pyproject.toml` as `uv add` will try to add marimo to the existing `.toml`.
30-
31-
```bash
32-
# move to a new dir
33-
mkdir sleap_nn_notebooks
34-
cd sleap_nn_notebooks
35-
36-
# initialize uv
37-
uv init
38-
39-
# Install marimo
40-
uv add marimo
41-
```
4225

4326
**Step-2 : Run the marimo notebooks**
4427

45-
Download the notebooks from [here](https://github.com/talmolab/sleap-nn/tree/main/example_notebooks) and ensure the python scripts are in your current working directory!
28+
Download the notebooks from [here](https://github.com/talmolab/sleap-nn/tree/main/example_notebooks)!
4629

4730
(i) Training Demo Notebook
4831

0 commit comments

Comments
 (0)