Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Release
# Publishes to PyPI when a GitHub release is published (tag it vX.Y.Z to match the version
# in pyproject.toml). Uses PyPI trusted publishing, so no API token is stored in the repo.
# One-time setup: on PyPI, add this repository and workflow (release.yml) as a trusted
# publisher for the "pelagos" project, using the "pypi" environment.
# publisher for the "pelagos-decoder" project, using the "pypi" environment.

on:
release:
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ accordingly.
## Install

```bash
pip install pelagos[gpu] # decoder + torch/triton
pip install pelagos[gpu,rust] # + the Rust CPU reference, side by side
pip install pelagos[gpu,stim] # + stim / DEM support
pip install pelagos-decoder[gpu] # decoder + torch/triton
pip install pelagos-decoder[gpu,rust] # + the Rust CPU reference, side by side
pip install pelagos-decoder[gpu,stim] # + stim / DEM support
```

Development uses [uv](https://docs.astral.sh/uv/):
Expand Down Expand Up @@ -127,7 +127,7 @@ decoder = RelayBPDecoder(H_csr=cm.check_matrix, error_priors=cm.error_priors, al
```

Note the field is `cm.error_priors`, not `cm.priors`. This path requires
the `stim` extra (`pip install pelagos[stim]`), which pulls in
the `stim` extra (`pip install pelagos-decoder[stim]`), which pulls in
`beliefmatching`.

## Tutorials
Expand Down Expand Up @@ -155,7 +155,7 @@ important ones are `--backend {rust,triton}`, `--circuit`, `--basis`,
needs `pandas`, which ships in the `bench` extra:

```bash
pip install "pelagos[gpu,bench]" # or: uv sync --extra gpu --extra bench
pip install "pelagos-decoder[gpu,bench]" # or: uv sync --extra gpu --extra bench
```

```bash
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "pelagos"
name = "pelagos-decoder"
version = "0.1.0"
description = "GPU-accelerated Relay-BP decoder for qLDPC codes, implemented in Triton."
readme = "README.md"
Expand Down Expand Up @@ -73,12 +73,12 @@ bench = [
]
# Dependencies for running the notebooks in tutorials/.
tutorials = [
"pelagos[gpu,stim]",
"pelagos-decoder[gpu,stim]",
"matplotlib",
"jupyterlab",
]
all = [
"pelagos[gpu,rust,stim,test,bench,tutorials]",
"pelagos-decoder[gpu,rust,stim,test,bench,tutorials]",
]

[tool.hatch.build.targets.wheel]
Expand Down
6 changes: 3 additions & 3 deletions tutorials/01_single_gpu_quickstart.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
"**Requirements:** a CUDA or ROCm GPU and the tutorial dependencies:\n",
"\n",
"```bash\n",
"pip install \"pelagos[tutorials]\" # or, from a clone: uv sync --extra tutorials\n",
"pip install \"pelagos-decoder[tutorials]\" # or, from a clone: uv sync --extra tutorials\n",
"```\n",
"\n",
"**Runtime:** about 3–4 minutes on a laptop GPU (RTX 3000 Ada, 8 GB). The first decode of each\n",
Expand Down Expand Up @@ -639,7 +639,7 @@
"(`tests/test_triton_against_rust.py`). Here we run both decoders with the same parameters on\n",
"the same shots. Their random number streams differ, so individual decodings can differ.\n",
"The logical error rates should agree within statistical error. Install the reference with\n",
"`pip install \"pelagos[rust]\"`."
"`pip install \"pelagos-decoder[rust]\"`."
]
},
{
Expand Down Expand Up @@ -669,7 +669,7 @@
" import relay_bp\n",
"except ImportError:\n",
" relay_bp = None\n",
" print(\"relay-bp not installed; skipping (pip install 'pelagos[rust]').\")\n",
" print(\"relay-bp not installed; skipping (pip install 'pelagos-decoder[rust]').\")\n",
"\n",
"if relay_bp is not None:\n",
" n = 512\n",
Expand Down
8 changes: 4 additions & 4 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading