Skip to content

[docs] add debugging docs #235

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

Merged
merged 16 commits into from
Jun 17, 2025
Merged

[docs] add debugging docs #235

merged 16 commits into from
Jun 17, 2025

Conversation

prashantgupta24
Copy link
Collaborator

@prashantgupta24 prashantgupta24 commented Jun 13, 2025

Description

Add debugging docs for vllm-spyre.

Copy link

👋 Hi! Thank you for contributing to vLLM support on Spyre.
Just a reminder: Make sure that your code passes all the linting checks, otherwise your PR won't be able to be merged. To do so, first install the linting requirements, then run format.sh and commit the changes. This can be done with uv directly:

uv sync --frozen --group lint --active --inexact

Or this can be done with pip:

uv pip compile --group lint > requirements-lint.txt
pip install -r requirements-lint.txt
bash format.sh

Now you are good to go 🚀

@prashantgupta24 prashantgupta24 marked this pull request as ready for review June 13, 2025 18:17
echo "======================================================================"
jq -n '{"GENERAL": { "sen_bus_id": "'"${device_id}"'" }}' > .senlib.json
# run in background to not override bash signal handler
timeout 10 /opt/sentient/senlib/bin/senlib_unit_test --gtest_filter=SmlPF1VF0.Open &
Copy link
Collaborator

Choose a reason for hiding this comment

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

thoughts on having the filter be a param here with this as a default? Not really necessary for a first pass but maybe eventually we can point to some docs on the different available tests and what they do

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yep, good suggestion for the next pass.

@prashantgupta24 prashantgupta24 changed the title ✨ add debugging docs [docs] add debugging docs Jun 16, 2025
@prashantgupta24 prashantgupta24 force-pushed the debugging-docs branch 3 times, most recently from 3dad98c to f2c0596 Compare June 16, 2025 20:05
prashantgupta24 and others added 9 commits June 16, 2025 14:01
Co-authored-by: Travis Johnson <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
prashantgupta24 and others added 6 commits June 16, 2025 14:01
Co-authored-by: Joe Runde <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Co-authored-by: Rafael Vasquez <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
Signed-off-by: Prashant Gupta <[email protected]>
@rafvasq rafvasq disabled auto-merge June 17, 2025 16:59
Copy link
Collaborator

@rafvasq rafvasq left a comment

Choose a reason for hiding this comment

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

I think the section would benefit from using more headers to separate the kinds of debugging you can do but I think this a good start until it grows! LGTM aside from fixing the "Topology ..." header above

Signed-off-by: Prashant Gupta <[email protected]>
@prashantgupta24 prashantgupta24 enabled auto-merge (squash) June 17, 2025 17:13
@prashantgupta24 prashantgupta24 merged commit c3ba0be into main Jun 17, 2025
21 checks passed
@prashantgupta24 prashantgupta24 deleted the debugging-docs branch June 17, 2025 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants