Remove installation and scaling from the main readme. They are already covered by the explicit steps in the sample readme.
This commit is contained in:
Forrest Trepte 2021-11-17 23:24:26 -08:00
Родитель 50795eda71
Коммит 0ed4172cf0
3 изменённых файлов: 7 добавлений и 28 удалений

Просмотреть файл

@ -21,36 +21,13 @@ information about Bonsai connectors and step-by-step instructions for implementi
A connector for using [SimPlatform] with [Microsoft Project Bonsai](https://azure.microsoft.com/en-us/services/project-bonsai/).
## Installation
> TODO: Give a brief overview of the capabilities of [SimPlatform] and entice users with potential use cases for using [SimPlatform] to create Bonsai brains for controlling autonomous systems.
> This section should list steps for installing components that users will need, such as:
> * [SimPlatform] applications, tools, or SDKs
> * The connector itself
> * Any other dependencies required by the connector
## Samples
## Usage: Running a local simulator
[[SampleName]](samples/[SampleName]/README.md)
> Assume that a user has already created a simulation using [SimPlatform]. Feel free to include a link to [SimPlatform]'s documentation if you think it would be helpful, but it isn't necessary to document how to use [SimPlatform] itself.
>
> This section should list steps for using the connector to run a [SimPlatform] simulation with the Bonsai service as a local simulator, such as:
> * Required or recommended settings that must be made in [SimPlatform] when users create simulations.
> * How the simulation's states, actions, and initial configuration should be set up in [SimPlatform].
> * How to execute the simulation as a local Bonsai simulator. For example, this could include an example command-line argument for doing so.
> * How to identify if your local simulator is running correctly. For example, something like: If the simulation is running successfully, command line output should show "Sim successfully registered" and the Bonsai workspace should show the [SimPlatform] simulator name under the Simulators section, listed as Unmanaged.
>
> Optional: Does the connector for [SimPlatform] allow an integrated way of launching a local simulator, debugging a local simulator, or visualizing a local simulator as it executes via a user interface inside [SimPlatform]? Such capabilities can be described here.
## Usage: Scaling your simulator
> This section should list steps for running multiple simulator instances to scale Bonsai training.
>
> Typically this is done by adding a simulator container to your Bonsai workspace. In that case, this section will include:
> * Command line arguments for building a container with the [SimPlatform] connector and the user's simulation.
> * A link to the documentation topic [Add a training simulator to your Bonsai workspace](https://docs.microsoft.com/en-us/bonsai/guides/add-simulator?tabs=add-cli%2Ctrain-inkling&pivots=sim-platform-other) for information about how to upload the container, add it to Bonsai, and scale the simulator.
>
> It is less desirable, but if it is the case that [SimPlatform] cannot be run inside a scalable container then an alternate means of scaling simulator instances such as [bonsai-batch](https://github.com/microsoft/bonsai-batch) can be documented here.
>
> Optional: Does the connector for [SimPlatform] allow an integrated way of uploading a simulator to the Bonsai service or scaling the simulator instances for training via a user interface inside [SimPlatform]? Such capabilities can be described here.
> TODO: Describe how a user could customize the supplied sample to run a different simulation model that they created with [SimPlatform].
## Trademarks

Просмотреть файл

@ -2,4 +2,4 @@
> This directory will contain the source code and other files that implement the connector.
> Optional: This README.md file can describe the architecture of the connector source code and highlight important context for someone new learning the codebase. Alternatively, if the architecture is self-explanatory or is already documented in comments within the source files themselves then this README.md file can be deleted.
> TODO: OPTIONAL: This README.md file can describe the architecture of the connector source code and highlight important context for someone new learning the codebase. Alternatively, if the architecture is self-explanatory or is already documented in comments within the source files themselves then this README.md file can be deleted.

Просмотреть файл

@ -42,6 +42,8 @@ Then install the Python requirements of this sample by:
pip install -r requirements.txt
```
> TODO: Add a step describing additional setup required such as installing your simulator runtime or a simulator license.
### 3. Connect local instance of the simulator
Run the simulator locally by: