.

Author: srush

docs/agent.md

@@ -3,7 +3,7 @@
 Commit0 is a command-line tool that allows you to run unit-tests on a
 variety of libraries in isolated environments.
 
-Commit0 uses [modal](https://modal.com/) as a distributed
+The defaul tool uses [modal](https://modal.com/) as a distributed
 test runner.
 
 ```bash
@@ -20,20 +20,27 @@ commit0 setup lite
 ```
 
 This will clone a set of skeleton libraries in your `repos/` directory.
-Commiting changes to branches in this directory
-
-
+Commiting changes to branches in this directory is how you send changes
+to the test runner.
 
+Next to run tests you can run the standard test command.
+This command will run a reference unit test for the `simpy` repo.
 
+```bash
+commit0 test simpy tests/test_event.py::test_succeed --reference
+```
 
-You can pass this configuration file as an argumnet to clone.
+To run a test in your codebase you can run with no args.
+This one will fail.
 
 ```bash
-commit0 setup lite
+commit0 test simpy tests/test_event.py::test_succeed
 ```
 
-Next to run tests you can run the standard test command.
+To run a test in your codebase with a specific branch
+you can commit to the branch and call with the --branch command.
+
 
 ```bash
-commit0 test simpy tests/test_event.py::test_succeed
+commit0 test simpy tests/test_event.py::test_succeed --branch my_branch
 ```

docs/setupdist.md

@@ -1,30 +1,29 @@
 ## Local Mode
 
-
-First be sure that you have docker tools installed.
+To run in local mode you first be sure that you have [docker tools](https://docs.docker.com/desktop/install/mac-install/)
+installed. On Debian systems:
 
 ```bash
 apt install docker
 ```
 
-To install the benchmark run,
-
+To get started, run the `setup` command with the dataset
+split that you are interested in working with.
+We'll start with the `lite` split.
 
-The system is a command-line tool that allows you to run unit-tests on a
-variety of libraries in isolated environments. To get started with the full
-setup run the `setup` command which will install a clone the code of a subset
-of libraries to your `repos/` directory.
 
 ```bash
 commit0 setup lite
 ```
 
+This will install a clone the code for subset of libraries to your `repos/` directory.
+
 Next run the `build` command which will configure Docker containers for
 each of the libraries with isolated virtual environments. The command uses the
 [uv](https://github.com/astral-sh/uv) library for efficient builds.
 
 ```bash
-commit0 build lit
+commit0 build
 ```
 
 The main operation you can do with these enviroments is to run tests.
@@ -34,36 +33,4 @@ Here we run [a test](https://github.com/commit-0/simpy/blob/master/tests/test_ev
 commit0 test simpy tests/test_event.py::test_succeed
 ```
 
-This test should run and pass, but others will fail.
-
-```bash
-commit0 test minitorch tests/test_operators.py::test_relu
-```
-
-Let's now manually go in and change that repo.
-This is all just standard shell commands.
-
-```bash
-cd repos/minitorch/
-git checkout -b mychange
-```
-
-And apply and commit this patch.
-
-```
---- a/minitorch/operators.py
-+++ b/minitorch/operators.py
-@@ -81,7 +81,7 @@ def relu(x: float) -> float:
-     (See https://en.wikipedia.org/wiki/Rectifier_(neural_networks) .)
-     """
-     # TODO: Implement for Task 0.1.
--    raise NotImplementedError('Need to implement for Task 0.1')
-+    return 1. if x > 0. else 0.
-```
-
-Once this is done we can run `test` with
-a branch and the environment will sync and run.
-
-```bash
-commit0 test minitorch branch=mychange tests/test_operators.py::test_relu
-```
+See [distributed setup](setupdist) for more commands.