diff --git a/README.md b/README.md index 5649f26..61663c6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -# echo +

+ echo +

+ CI Docs PyPI Python @@ -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. -

📖 Documentation

- ## Install ```bash @@ -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): 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