From 0f1a16623d326d455780891003620500154d6bd0 Mon Sep 17 00:00:00 2001 From: Sasha Abramowitz Date: Wed, 20 May 2026 17:45:09 +0200 Subject: [PATCH 1/3] docs: readme updates --- README.md | 9 ++++++--- docs/logo.svg | 13 +++++++++++++ 2 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 docs/logo.svg diff --git a/README.md b/README.md index 5649f26..bd2db83 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ +

+ echo +

+ # echo

+ CI Docs PyPI Python @@ -11,8 +16,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. -

📖 Documentation

- ## Install ```bash @@ -47,7 +50,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): diff --git a/docs/logo.svg b/docs/logo.svg new file mode 100644 index 0000000..2ea4294 --- /dev/null +++ b/docs/logo.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + From ca6e2d07165fab58de086e6579747d626552af2e Mon Sep 17 00:00:00 2001 From: Sasha Abramowitz Date: Wed, 20 May 2026 17:55:26 +0200 Subject: [PATCH 2/3] chore: update logo --- docs/logo.svg | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/logo.svg b/docs/logo.svg index 2ea4294..64bd75f 100644 --- a/docs/logo.svg +++ b/docs/logo.svg @@ -1,13 +1,13 @@ - + - - - - + + + + From b64ffcae3d55dd350b80dc7dc30bf641564aa42c Mon Sep 17 00:00:00 2001 From: Sasha Abramowitz Date: Thu, 21 May 2026 09:56:37 +0200 Subject: [PATCH 3/3] docs: nicer logo --- README.md | 4 +--- docs/logo.svg | 13 ------------- docs/src/assets/logo.svg | 22 ++++++++++++++++++++++ docs/src/index.md | 4 +++- mkdocs.yml | 1 + 5 files changed, 27 insertions(+), 17 deletions(-) delete mode 100644 docs/logo.svg create mode 100644 docs/src/assets/logo.svg diff --git a/README.md b/README.md index bd2db83..61663c6 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@

- echo + echo

-# echo -

CI Docs diff --git a/docs/logo.svg b/docs/logo.svg deleted file mode 100644 index 64bd75f..0000000 --- a/docs/logo.svg +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - - diff --git a/docs/src/assets/logo.svg b/docs/src/assets/logo.svg new file mode 100644 index 0000000..85f550f --- /dev/null +++ b/docs/src/assets/logo.svg @@ -0,0 +1,22 @@ + + echo + + + + ech + + + + + + + + + diff --git a/docs/src/index.md b/docs/src/index.md index 42dc090..09434da 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,4 +1,6 @@ -# echo +

+ echo +

A very fast distributed replay buffer for reinforcement learning. The core is a lockfree, pre-allocated Rust ring buffer; batches come back to Python diff --git a/mkdocs.yml b/mkdocs.yml index b7fb23c..e32abae 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,6 +9,7 @@ site_dir: docs/site theme: name: material + logo: assets/logo.svg features: - navigation.tabs - navigation.sections