| … | … | @@ -109,24 +109,39 @@ jupyter notebook 01_cartpole.ipynb |
| 109 | 109 | ``` |
| 110 | 110 | |
| 111 | 111 | ### TensorBoard support |
| 112 | | Some experiments, notably the notebooks, use TensorBoard via the `tensorboardX` library to store event files that show certain metrics over time for training / testing (for now it's just rewards). |
| 113 | 112 | |
| 114 | | By default, event files will be created under the `runs/<datetime><comment>` directory. You can invoke |
| 115 | | `tensorboard --logdir runs` from the project root to start an instance that will see all the files under that directory. Open your browser to `http://localhost:6006` to see its interface. |
| 113 | Some experiments, notably the notebooks, use TensorBoard via the |
| 114 | `tensorboardX` library to store event files that show certain metrics |
| 115 | over time for training / testing (for now it's just rewards). |
| 116 | |
| 117 | By default, event files will be created under the |
| 118 | `runs/<datetime><comment>` directory. You can invoke `tensorboard |
| 119 | --logdir runs` from the project root to start an instance that will |
| 120 | see all the files under that directory. Open your browser to |
| 121 | `http://localhost:6006` to see its interface. |
| 116 | 122 | |
| 117 | 123 | ## Develop |
| 118 | 124 | |
| 119 | | If you write code in notebooks that is exported (has the `#export` comment on top of the cell), remember to invoke `nbdev_build_lib` to update the library. Remember to use `black` for formatting, you can invoke `black .` from the project root to format everything. |
| 125 | If you write code in notebooks that is exported (has the `#export` |
| 126 | comment on top of the cell), remember to invoke `nbdev_build_lib` to |
| 127 | update the library. Remember to use `black` for formatting, you can |
| 128 | invoke `black .` from the project root to format everything. |
| 120 | 129 | |
| 121 | | You can also use the Makefile for your convenience, invoking `make rocca` will do both of the above in sequence. |
| 130 | You can also use the Makefile for your convenience, invoking `make |
| 131 | rocca` will do both of the above in sequence. |
| 122 | 132 | |
| 123 | 133 | ### Development container |
| 124 | 134 | |
| 125 | | The `.devcontainer` folder has configuration for [VS Code devcontainer](https://code.visualstudio.com/docs/remote/containers) functionality. You can use it to setup a development environment very quickly and regardless of the OS you use. |
| 135 | The `.devcontainer` folder has configuration for [VS Code |
| 136 | devcontainer](https://code.visualstudio.com/docs/remote/containers) |
| 137 | functionality. You can use it to setup a development environment very |
| 138 | quickly and regardless of the OS you use. |
| 126 | 139 | |
| 127 | | The container has a JupyterLab instance running on the port 8888. |
| 128 | | The container has a VNC server running on the port 5901. |
| 129 | | The password for the VNC server started in the container is `vncpassword`. You can use any VNC client to see the results of rendering Gym environments this way. |
| 140 | - The container has a JupyterLab instance running on the port 8888. |
| 141 | - The container has a VNC server running on the port 5901. |
| 142 | - The password for the VNC server started in the container is |
| 143 | `vncpassword`. You can use any VNC client to see the results of |
| 144 | rendering Gym environments this way. |
| 130 | 145 | |
| 131 | 146 | ## Tests |
| 132 | 147 | |