Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken links in examples/4_train_policy_with_script.md #697

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

tc-huang
Copy link
Contributor

@tc-huang tc-huang commented Feb 8, 2025

What this does

This PR fixes 7 broken relative path links in the examples/4_train_policy_with_script.md file by updating the relative path prefix from ../../ to ../:

  1. (line 7) ../../lerobot/scripts/train.py../lerobot/scripts/train.py
  2. (line 24) ../../lerobot/configs/train.py../lerobot/configs/train.py
  3. (line 53)../../lerobot/common/policies/diffusion../lerobot/common/policies/diffusion
  4. (line 63) ../../lerobot/common/policies../lerobot/common/policies
  5. (line 64) ../../lerobot/common/envs/configs.py../lerobot/common/envs/configs.py
  6. (line 66)../../lerobot/common/policies/act../lerobot/common/policies/act
  7. (line 77)../../lerobot/common/envs/configs.py../lerobot/common/envs/configs.py

For example:

  • Before change: When clicking the lerobot/scripts/train.py link (displayed as blue hyperlinks in the screenshot below) in the GitHub preview of examples/4_train_policy_with_script.md, a '404 - Page not found' message is shown:
    截圖 2025-02-09 凌晨12 08 21
    截圖 2025-02-09 凌晨12 09 31
  • After change: After updating the markdown link from [lerobot/scripts/train.py](../../lerobot/scripts/train.py) to [lerobot/scripts/train.py](../lerobot/scripts/train.py), the link correctly directs to the intended page, as shown in the following screenshot:
    截圖 2025-02-09 凌晨12 15 10

How it was tested

Since this PR only modifies an example document written in Markdown format, I tested the changes as described in the How to checkout & try? section below.

How to checkout & try? (for the reviewer)

  1. Preview the updated Markdown file examples/4_train_policy_with_script.md on GitHub.
  2. Use your web browser's search function to locate the following text snippets:
    LeRobot offers a training script at lerobot/scripts/train.py
    
    You can inspect the TrainPipelineConfig defined in lerobot/configs/train.py
    
    Let's say that we want to train Diffusion Policy
    
    The policies available to select are located in lerobot/common/policies
    
    The different environment configs are available in lerobot/common/envs/configs.py
    
    Let's see another example. Let's say you've been training ACT
    
    Looking at the AlohaEnv config
    
  3. Click the corresponding links to verify that they direct to the correct pages.

This commit fixes 4 broken path links in the
`examples/4_train_policy_with_script.md` file
by changing the relative path prefix from
`../../` to `../`:

1. (line 7) `../../lerobot/scripts/train.py`
    → `../lerobot/scripts/train.py`
2. (line 24)`../../lerobot/configs/train.py`
    → `../lerobot/configs/train.py`
3. (line 63)`../../lerobot/common/policies`
    → `../lerobot/common/policies`
4. (line 64)`../../lerobot/common/envs/configs.py`
    → `../lerobot/common/envs/configs.py`
This commit fixes 3 more broken path links in the
`examples/4_train_policy_with_script.md` file
by changing the relative path prefix from
`../../` to `../`:

1. (line 53)`../../lerobot/common/policies/diffusion`
    → `../lerobot/common/policies/diffusion`
2. (line 66)`../../lerobot/common/policies/act`
    → `../lerobot/common/policies/act`
3. (line 77)`../../lerobot/common/envs/configs.py`
    → `../lerobot/common/envs/configs.py`
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.

1 participant