Skip to content
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

Add ba watcher #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add ba watcher #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e31108c
feat: add doc
xtuc Feb 3, 2018
dc89652
feat: add watcher build
xtuc Feb 3, 2018
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
10 changes: 10 additions & 0 deletions content/guides/agent-training/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,13 @@ Over 60 tps the visualization might not be as fluid anymore. The alternative is
### Use the file recorder

Currently in development.

## Automatically rebuild and restart

You can run the following command to start the watcher:

```sh
ba train --watch path/to/your/agent
```

That will automatically rebuild and restart your agent when a change is detected.
2 changes: 1 addition & 1 deletion content/guides/bytearena-cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ Please refer to the [Building the agent](/guides/getting-started/#building-the-a

## Scaffolding

Please refer to the [Building the agent](/guides/getting-started/#scaffolding-the-source-code-of-an-agent).
Please refer to the [Scaffolding the source code of an agent](/guides/getting-started/#scaffolding-the-source-code-of-an-agent).
16 changes: 13 additions & 3 deletions content/guides/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,7 @@ Building an agent means producing a runnable Docker image with the agent code.

As we have seen in the previous example, the scaffolding operation has already built the agent for us.

<strong>Note:</strong> if you want to modify the id (`powerful-jennet` here for example) of your agent, the steps are explained in the [agent-configuration guide](guides/agent-configuration/).

## Recommended way
<strong>Note:</strong> if you want to modify the id (`powerful-jennet` here for example) of your agent, the steps are explained in the [agent-configuration guide](/guides/agent-configuration/).

If you want to rebuild it though, you need to issue this command:

Expand All @@ -64,6 +62,8 @@ You can also skip the path altogether in the command if you are in the root fold
$ ba build
```

<strong>Note:</strong> you can also pass `--watch` to the previous command to automatically rebuild when a file changed.

# Giving it a ride

The agent you just built is already able to fly!
Expand Down Expand Up @@ -343,3 +343,13 @@ const steering = new Vector2(-0.5, 0);
This concludes the Byte Arena "Getting Started" guide.

From there you can proceed to the ["Basic obstacle avoidance" guide](/guides/basic-obstacle-avoidance) to learn how to make your way around obstacles in the world.

## Automatically rebuild and restart

You can run the following command to start the watcher:

```sh
ba train --watch path/to/your/agent
```

That will automatically rebuild and restart your agent when a change is detected.