fix(stable-baselines3): repair broken API reference links (#233)
The "API Reference" bullets in references/callbacks.md and references/vectorized_envs.md pointed at `/en/master/common/callbacks.html` and `/en/master/common/vec_env.html`, which both return 404. Upstream Stable-Baselines3 documents the `stable_baselines3.common.callbacks` and `stable_baselines3.common.vec_env` modules on the same pages as their narrative guides, not under `common/`. Repoint both links at the module anchors on the guide pages: - guide/callbacks.html#module-stable_baselines3.common.callbacks - guide/vec_envs.html#module-stable_baselines3.common.vec_env Both targets and both anchors were verified against the live docs and the upstream genindex. The "Official ... Guide" bullet directly above each one already used the correct `guide/` path, so the two `common/` URLs were inconsistent within their own files. Bump metadata.version to "1.2". Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
committed by
GitHub
parent
7b0386d917
commit
72d742e153
@@ -5,7 +5,7 @@ license: MIT license
|
||||
allowed-tools: Read Write Edit Bash
|
||||
compatibility: Requires Python 3.10+, PyTorch >= 2.3, and stable-baselines3 2.8+. Gymnasium environments; optional extras for TensorBoard and Atari (ale-py).
|
||||
metadata:
|
||||
version: "1.1"
|
||||
version: "1.2"
|
||||
skill-author: K-Dense Inc.
|
||||
---
|
||||
|
||||
|
||||
@@ -567,5 +567,5 @@ class DebugCallback(BaseCallback):
|
||||
## Additional Resources
|
||||
|
||||
- Official SB3 Callbacks Guide: https://stable-baselines3.readthedocs.io/en/master/guide/callbacks.html
|
||||
- Callback API Reference: https://stable-baselines3.readthedocs.io/en/master/common/callbacks.html
|
||||
- Callback API Reference: https://stable-baselines3.readthedocs.io/en/master/guide/callbacks.html#module-stable_baselines3.common.callbacks
|
||||
- TensorBoard Documentation: https://www.tensorflow.org/tensorboard
|
||||
|
||||
@@ -576,5 +576,5 @@ model = PPO.load("model", env=eval_env)
|
||||
## Additional Resources
|
||||
|
||||
- Official SB3 VecEnv Guide: https://stable-baselines3.readthedocs.io/en/master/guide/vec_envs.html
|
||||
- VecEnv API Reference: https://stable-baselines3.readthedocs.io/en/master/common/vec_env.html
|
||||
- VecEnv API Reference: https://stable-baselines3.readthedocs.io/en/master/guide/vec_envs.html#module-stable_baselines3.common.vec_env
|
||||
- Multiprocessing Best Practices: https://docs.python.org/3/library/multiprocessing.html
|
||||
|
||||
Reference in New Issue
Block a user