Skip to content

docs: add logo #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sash-a merged 3 commits into from
May 21, 2026
Merged

docs: add logo #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f1a166
docs: readme updates
sash-a May 20, 2026
ca6e2d0
chore: update logo
sash-a May 20, 2026
b64ffca
docs: nicer logo
sash-a May 21, 2026
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
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# echo
<p align="center">
<img src="docs/src/assets/logo.svg" alt="echo" width="320">
</p>

<p align="center">
<a href="https://github.com/instadeepai/echo/actions/workflows/ci.yml"><img src="https://github.com/instadeepai/echo/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
<a href="https://instadeepai.github.io/echo/"><img src="https://img.shields.io/badge/docs-instadeepai.github.io%2Fecho-blue?style=flat-square&logo=materialformkdocs" alt="Docs"></a>
<a href="https://pypi.org/project/id-echo/"><img src="https://img.shields.io/pypi/v/id-echo?style=flat-square&logo=pypi&logoColor=white" alt="PyPI"></a>
<a href="https://github.com/instadeepai/echo/blob/main/pyproject.toml"><img src="https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Finstadeepai%2Fecho%2Fmain%2Fpyproject.toml&style=flat-square&logo=python&logoColor=white&label=python" alt="Python"></a>
Expand All @@ -11,8 +14,6 @@ is a lockfree, pre-allocated Rust ring buffer. Batches come back to Python
as zero-copy numpy views, with the GIL released while you wait for the next
batch.

<p align="center"><a href="https://instadeepai.github.io/echo/"><b>📖 Documentation</b></a></p>

## Install

```bash
Expand Down Expand Up @@ -47,7 +48,7 @@ pytree-agnostic.
## Example

A typical setup runs the server on the learner node and clients on rollout
workers (separate processes or machines).
workers (separate processes or machines). See more detailed examples in the [documentation](https://instadeepai.github.io/echo/).

**Learner side** (one process):

Expand Down
22 changes: 22 additions & 0 deletions docs/src/assets/logo.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# echo
<p align="center">
<img src="assets/logo.svg" alt="echo" width="320">
</p>

A very fast distributed replay buffer for reinforcement learning. The core
is a lockfree, pre-allocated Rust ring buffer; batches come back to Python
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ site_dir: docs/site

theme:
name: material
logo: assets/logo.svg
features:
- navigation.tabs
- navigation.sections
Expand Down
Loading