Skip to content

feat: Create Jupyter notebook for OSRS RL training - #2

Open
ConjureGanja wants to merge 2 commits into
Naton1:masterfrom
ConjureGanja:osrs-rl-notebook
Open

feat: Create Jupyter notebook for OSRS RL training#2
ConjureGanja wants to merge 2 commits into
Naton1:masterfrom
ConjureGanja:osrs-rl-notebook

Conversation

@ConjureGanja

Copy link
Copy Markdown

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.

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.
Copilot AI review requested due to automatic review settings June 11, 2025 00:37

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ./logs and ./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 run instead of ./gradlew run to 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
ConjureGanja marked this pull request as draft June 16, 2025 06:35
@ConjureGanja
ConjureGanja marked this pull request as ready for review November 9, 2025 19:14

@ConjureGanja ConjureGanja left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems so far so good. Has the added steps for setting up environment and launching scripts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants