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

Added Aurora DeepSpeed content #581

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

Added Aurora DeepSpeed content #581

wants to merge 3 commits into from

Conversation

hatanp
Copy link

@hatanp hatanp commented Dec 16, 2024

First draft for DeepSpeed on Aurora. Modified from Polaris instructions and tested to work.

@hatanp hatanp requested a review from saforem2 December 16, 2024 18:20

The base `frameworks` environment on Aurora does not come with Microsoft's
[DeepSpeed](https://github.com/microsoft/DeepSpeed) pre-installed and it needs to be installed by the user. Instructions
for using / cloning the base environment can be found [here](../python.md).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
for using / cloning the base environment can be found [here](../python.md).
for using and cloning the base environment can be found [here](../python.md).

Copy link
Author

Choose a reason for hiding this comment

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

To me "using and cloning" seems to imply the two are related. They are two separate topics. The slash was how it is in Polaris documentation. If words are preferred, then I would maybe go with "or"

Copy link
Member

Choose a reason for hiding this comment

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

no need to overthink this one; go with whatever you find best.

instructions for both steps are found at that link, hence why I suggested "and"

IMO using "or" or "and" seems a bit more polished than "/" in our user docs, although I am guilty of using it from time to time

docs/aurora/data-science/frameworks/deepspeed.md Outdated Show resolved Hide resolved
docs/aurora/data-science/frameworks/deepspeed.md Outdated Show resolved Hide resolved
sed -e 's/$/ slots=12/' -i hostfile
```

2. Create a `#!bash .deepspeed_env` containing the environment
Copy link
Member

Choose a reason for hiding this comment

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

I had a conversation with @saforem2 about the use of syntax highlighting for inline code markup like you use here with #!bash ...

We concluded that it isnt really worth the marginal gains for such short pieces of text, since it doesnt render in GitHub Flavored Markdown and has different escaping conventions.
image

Kinda degrades the readability when you are editing someone else's source text. Have you found it to be helpful?

Copy link
Author

Choose a reason for hiding this comment

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

Unfortunately I am not following. This was just copied from Polaris docs and I did no changes to the formatting nor am I familiar with it. This looked fine and just like the Polaris docs when I rendered the document. Is the issue that this is hard to read in GitHub? What was the solution you concluded on in the discussion?

I have no opinion on how syntax highlighting should be implemented so feel free to propose changes as seems like both of you have better idea than I do. I do not have the skills to make educated choices on this. I just took something that was used before and worked in the rendered document.

Copy link
Member

Choose a reason for hiding this comment

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

I am suggesting just using .deepspeed_env

Copy link
Member

Choose a reason for hiding this comment

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

`.deepspeed_env`
instead of
`#!bash .deepspeed_env`

Copy link
Member

Choose a reason for hiding this comment

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

https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#highlighting-inline-code-blocks
this where the feature is discussed--- still can be useful for highlighting syntax for inline Python etc. but less useful for a single word Bash command or filename

@hatanp
Copy link
Author

hatanp commented Jan 9, 2025

@saforem2 Did you have a chance to check this document? I just took whatever was in Polaris docs and modified it a bit so some details could have escaped me, so a second pair of eyes on this would be great. Also, looks like I did not receive any notifications from all the comments here and I now resolved a few. Thanks @felker!

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.

2 participants