#2369: Reduce dependency on manually replacing primaite version across documentation
This commit is contained in:
@@ -17,12 +17,12 @@ Running Jupyter Notebooks
|
||||
.. code-block:: bash
|
||||
:caption: Unix
|
||||
|
||||
cd ~/primaite/PRIMAITE_VERSION_TOKEN
|
||||
cd ~/primaite/{VERSION}
|
||||
|
||||
.. code-block:: powershell
|
||||
:caption: Windows (Powershell)
|
||||
|
||||
cd ~\primaite\PRIMAITE_VERSION_TOKEN
|
||||
cd ~\primaite\{VERSION}
|
||||
|
||||
2. Run jupyter notebook
|
||||
|
||||
|
||||
@@ -38,12 +38,12 @@ Install PrimAITE
|
||||
.. code-block:: bash
|
||||
:caption: Unix
|
||||
|
||||
mkdir -p ~/primaite/3.0.0b6
|
||||
mkdir -p ~/primaite/{VERSION}
|
||||
|
||||
.. code-block:: powershell
|
||||
:caption: Windows (Powershell)
|
||||
|
||||
mkdir ~\primaite\3.0.0b6
|
||||
mkdir ~\primaite\{VERSION}
|
||||
|
||||
|
||||
2. Navigate to the primaite directory and create a new python virtual environment (venv)
|
||||
@@ -51,7 +51,7 @@ Install PrimAITE
|
||||
.. code-block:: bash
|
||||
:caption: Unix
|
||||
|
||||
cd ~/primaite/3.0.0b6
|
||||
cd ~/primaite/{VERSION}
|
||||
python3 -m venv .venv
|
||||
|
||||
.. code-block:: powershell
|
||||
|
||||
@@ -35,7 +35,7 @@ Outputs
|
||||
-------
|
||||
|
||||
Running a session creates a session output directory in your user data folder. The filepath looks like this:
|
||||
``~/primaite/3.0.0b6/sessions/YYYY-MM-DD/HH-MM-SS/``. This folder contains the simulation sys logs generated by each node,
|
||||
``~/primaite/{VERSION}/sessions/YYYY-MM-DD/HH-MM-SS/``. This folder contains the simulation sys logs generated by each node,
|
||||
the saved agent checkpoints, and final model. The folder also contains a .json file for each episode step that
|
||||
contains the action, reward, and simulation state. These can be found in
|
||||
``~/primaite/3.0.0b6/sessions/YYYY-MM-DD/HH-MM-SS/simulation_output/episode_<n>/step_metadata/step_<n>.json``
|
||||
``~/primaite/{VERSION}/sessions/YYYY-MM-DD/HH-MM-SS/simulation_output/episode_<n>/step_metadata/step_<n>.json``
|
||||
|
||||
Reference in New Issue
Block a user