Add docs for GPU saturation tool #241
Conversation
To sync with ethz
|
preview available: https://docs.tds.cscs.ch/241 |
| ENV DEBIAN_FRONTEND=noninteractive | ||
|
|
||
| RUN apt-get update \ | ||
| && apt-get install -y wget rsync rclone vim git htop nvtop nano \ |
| ``` | ||
| As you can see from the above example, gssr can easily be installed with a `RUN pip install gssr` command. | ||
|
|
||
| Once your `ContainerFile` is ready, you can build it on any Alps platforms with the following commands to create a container with label `mycontainer`. |
There was a problem hiding this comment.
The docs have a guide on how to build containers on Alps, that you could like to.
For more information about building containers on Alps, see our [Podman guide][ref-building-containers].
|
|
||
| ## Create CSCS configuration for Container | ||
|
|
||
| The next step is to tell CSCS container engine solution where your container is and how you would like to run it. To do so, you will have to create a`{label}.toml` file in your `$HOME/.edf` directory. |
There was a problem hiding this comment.
You can use the existing documentation for the EDF file format, to make your life easier.
Find sections to link to here: https://docs.cscs.ch/software/container-engine/
| * [Quickstart Guide][ref-gssr-quickstart] | ||
| * [Container Guide][ref-gssr-containers] | ||
|
|
||
| This tool will produce time-series and heatmaps of the profiled metric values. Here is an example of one set of plots generated by the tool from the application Megatron-LLM from EPFL. |
There was a problem hiding this comment.
The guidance on including images has been updated:
https://docs.cscs.ch/contributing/#screenshots
There was a problem hiding this comment.
Too follow up - the images are attractive and suggest that the tool is capable of providing diverse feedback.
Maybe you could add a brief documentation about the type of feedback provided, and use the images to illustrate this?
|
@cerlane what's the status of this PR? Do you think you'll have time to implement some of the suggested changes or would you like any help in getting it merged? |
Co-authored-by: Ben Cumming <bcumming@cscs.ch>
Co-authored-by: Ben Cumming <bcumming@cscs.ch>
Co-authored-by: Ben Cumming <bcumming@cscs.ch>
|
preview available: https://docs.tds.cscs.ch/241 |
Start again using a branch from #231