Skip to content

docs: clarify getting started entry points #361

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

Open
Vinayaktoor wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify getting started entry points #361

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,27 @@ in our [technical report][Paper].
[documentation]: https://dm-acme.readthedocs.io/
[paper]: https://arxiv.org/abs/2006.00979

### Understanding the examples and demonstrations

Acme provides multiple entry points depending on how you prefer to learn:

- The `examples/` directory contains working code examples that show how to
instantiate agents and run them in different environments.

- The [quickstart notebook][Quickstart] provides the fastest path to running a
single agent end-to-end.

- The [tutorial notebook][Tutorial] offers a deeper, step-by-step explanation
of how Acme agents are constructed internally.

In addition, `bsuite_demonstrations.py` demonstrates how Acme agents are
evaluated using the bsuite benchmark, showcasing a more research-oriented
workflow with systematic evaluation and logging.

New users are encouraged to start with the quickstart notebook, then explore
the examples directory and bsuite demonstrations to better understand Acme’s
design philosophy.

## Installation

To get up and running quickly just follow the steps below:
Expand Down