mirror of
https://github.com/volcengine/verl.git
synced 2025-10-20 13:43:50 +08:00
9d66534060
### What does this PR do? Added two Ray CLI commands to the documentation for better job monitoring: 1. **Job ID Retrieval Command** `ray job list | grep submission_id | grep JobStatus | grep RUNNING | grep -oP 'raysubmit_[^'\''"]+' | head -n 1` This pipeline fetches the latest running job's submission ID by: - Filtering active jobs (`RUNNING` status) - Extracting `raysubmit_*` IDs - Returning the first match 2. **Continuous Log Streaming** `ray job logs <Submission ID> --follow` Added the `--follow` parameter to enable real-time log streaming, allowing users to: - Continuously monitor job output - Debug long-running processes interactively - Maintain persistent log connection until job completion These additions enhance operational visibility for Ray job management workflows.
verl documentations
Build the docs
# If you want to view auto-generated API docstring, please make sure verl is available in python path. For instance, install verl via:
# pip install .. -e[test]
# Install dependencies needed for building docs.
pip install -r requirements-docs.txt
# Build the docs.
make clean
make html
Open the docs with your browser
python -m http.server -d _build/html/
Launch your browser and navigate to http://localhost:8000 to view the documentation. Alternatively you could drag the file _build/html/index.html to your local browser and view directly.