Skip to content
Open
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
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
<p align="center">
<img src="docs/logo.svg" alt="echo" width="180">
</p>

# echo

<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 +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.

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

## Install

```bash
Expand Down Expand Up @@ -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):

Expand Down
13 changes: 13 additions & 0 deletions docs/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading