Profiling and performance tuning with SambaTune

This section covers how to use the SambaTune profiling performance tuning tool, and the SambaTune UI for viewing the results.

SambaTune uses a yaml file that describes how to profile an application.
There are samples in /opt/sambaflow/sambatune/configs.
This section shows how to run the simplest sample, a linear net.

First, ssh into one of the nodes in the SN30 cluster.
Next, start a slurm interative job reserving a full node (8 RDUs), for 8 hours (480 minutes):

$ /usr/local/bin/srun --time=480 --gres=rdu:8 --pty bash

Record the hostname:

$ hostname
sn30-r1-h1

Next, set an environment variable indicating where the profiling information should be stored:

export DUMP_ROOT=~/Sambatune

If running a large model, the profiling information can be hundreds of gigabytes or more, and the DUMP_ROOT should be set to some location with more storage than your home directory (which has a quota).
E.g. somewhere that you have write access to in /projects

Optionally, examine the sample yaml file. You will see that it has 5 top-level sections: app:, model-args:, compile-args:, run-args:, env:

Next, run sambatune using a sample sambatune yaml configuration file. This sample command line requests profiling with the benchmark, instrument, and run modes.

$ sambatune --modes benchmark instrument run -- /opt/sambaflow/sambatune/configs/linear_net.yaml

This will take a while to run, particularly if the yaml for a larger model is used.

Then, run sambatune_ui:

$ export ST_PORT=8576
$ sambatune_ui --directory $DUMP_ROOT/artifact_root/sambatune_gen --port $ST_PORT

Copy the password shown (e.g. to your clipboard). The userid is always admin. The password is different for every sambatune_ui run.

In a fresh console on your working machine where you will run the browser, set up a two-hop ssh tunnel to the target node. Replace the ALCFUserID in the ssh command line with your ALCF userid.

$ export ST_PORT=8576
$ ssh -L $ST_PORT:localhost:$ST_PORT ALCFUserID@sambanova.alcf.anl.gov  -t ssh -L $ST_PORT:localhost:$ST_PORT -N sn30-r1-h1

Put localhost:8576 in the url bar of a Chrome-family browser. (Chrome, Brave, Vivaldi, Opera tested.)
A login prompt for the sambatune ui should show.
Enter admin and the password copied previously.
You should now see the SambaTune UI.

If the browser does not show a login prompt, or if any previous step complains about a port conflict, try another value for ST_PORT on both the target node and for the ssh tunnel command, e.g. 8577.

See SambaNova's SambaTune documentation for more information about using SambaTune and the SambaTune UI.
This section is a good starting point: Workflow overview

When finished:
- Break the ssh tunnel with ctrl-c or equivalent.
- Stop the sambatune_ui server on the target node with ctrl-c or equivalent.
- Exit the interactive slurm job to release the reserved resources.

A disconnected job can be canceled by determining its job id with squeue -a and canceling the job with scancel <jobid>