feat: Create Jupyter notebook for OSRS RL training - #2
Open
ConjureGanja wants to merge 2 commits into
Open
Conversation
This commit introduces a new Jupyter notebook, `rl_training_osrs.ipynb`, designed to guide you through setting up and running reinforcement learning training for an OSRS agent using this repository. The notebook includes the following sections: - Project Structure: Overview of the key directories and their contents. - Setting up the Conda Environment: Instructions for creating and activating the necessary Conda environment, which includes PyTorch and Java 17. - Launching the OSRS Simulation Server: Steps to run the Elvarg RSPS based simulation environment. - Starting a Training Job: How to initiate an RL training process using predefined configurations. - Monitoring Training with TensorBoard: Instructions for visualizing training metrics. - Evaluating a Trained Model: How to run a trained agent in the simulation. - Serving Models via API: Information on deploying models as an API service. - Conclusion and Next Steps: Summary and suggestions for further exploration. The notebook aims to provide a clear and comprehensive guide for you to get started with the OSRS RL project. Content was derived from existing README files and organized into a step-by-step tutorial format.
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new Jupyter notebook (rl_training_osrs.ipynb) that walks users through setting up, training, evaluating, and serving an OSRS RL agent using the repository.
- Introduces step-by-step instructions in a notebook format
- Covers environment setup, simulation server launch, and training workflow
- Includes sections on monitoring, evaluation, and serving models via API
Comments suppressed due to low confidence (3)
rl_training_osrs.ipynb:7
- [nitpick] Consider adding a 'Prerequisites' section before the project structure to specify required Python and Java versions, OS support, and any other system dependencies.
## 1. Project Structure
rl_training_osrs.ipynb:166
- Clarify the default location of TensorBoard log files and ensure consistency with the earlier mention of logs stored in
./logsand./experiments/<name>.
This command specifically looks for TensorBoard logs generated by the training framework.
rl_training_osrs.ipynb:89
- Add a note that on Windows systems the user should run
gradlew.bat runinstead of./gradlew runto avoid confusion.
./gradlew run
This commit updates the `rl_training_osrs.ipynb` Jupyter notebook to include a new 'Prerequisites' section at the beginning. This section details the necessary system requirements for you, including: - Supported Operating Systems (Linux, macOS, Windows with WSL) - Git for repository cloning - Conda for environment management - Python version (managed by Conda) - Java versions (Java 17 for the server, installed by Conda; optional Java 11 for the Elvarg client). This addition addresses your feedback to make setup requirements clearer before diving into project-specific steps. Subsequent section numbering has been adjusted accordingly.
ConjureGanja
marked this pull request as draft
June 16, 2025 06:35
ConjureGanja
marked this pull request as ready for review
November 9, 2025 19:14
DaveInchy
approved these changes
Nov 24, 2025
ConjureGanja
commented
Nov 27, 2025
ConjureGanja
left a comment
Author
There was a problem hiding this comment.
Seems so far so good. Has the added steps for setting up environment and launching scripts.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commit introduces a new Jupyter notebook,
rl_training_osrs.ipynb, designed to guide you through setting up and running reinforcement learning training for an OSRS agent using this repository.The notebook includes the following sections:
The notebook aims to provide a clear and comprehensive guide for you to get started with the OSRS RL project. Content was derived from existing README files and organized into a step-by-step tutorial format.