Skip to content

Commit 7991d86

Browse files
authored
update docs
1 parent fdf254c commit 7991d86

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

doc/env.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,17 +95,18 @@ List of customized OP plugin libraries to load, such as `/path/to/plugin1.so:/pa
9595
{{ pytorch_icon }} Enable the built-in PyTorch Kineto profiler for the PyTorch C++ (inference) backend.
9696

9797
**Type**: string (output file stem)
98+
9899
**Default**: unset (disabled)
99100

100-
When set to a non-empty value, profiling is enabled for the lifetime of the loaded PyTorch model (e.g. during LAMMPS runs). A JSON trace file is written on finish. The final file name is constructed as:
101+
When set to a non-empty value, profiling is enabled for the lifetime of the loaded PyTorch model (e.g. during LAMMPS runs). A JSON trace file is created on finish. The final file name is constructed as:
101102

102-
- `<ENV_VALUE>_gpu<ID>.json` if running on GPU (multi-GPU safe: the CUDA device id is appended)
103+
- `<ENV_VALUE>_gpu<ID>.json` if running on GPU
103104
- `<ENV_VALUE>.json` if running on CPU
104105

105-
The trace is compatible with [Chrome trace viewer](https://ui.perfetto.dev/) (alternatively chrome://tracing) and PyTorch profiler tooling. It includes:
106+
The trace can be examined with [Chrome trace viewer](https://ui.perfetto.dev/) (alternatively chrome://tracing). It includes:
106107

107-
- CPU operator activities (always)
108-
- CUDA activities (if GPU available)
108+
- CPU operator activities
109+
- CUDA activities (if available)
109110

110111
Example:
111112

@@ -119,4 +120,5 @@ Tips:
119120

120121
- Large runs can generate sizable JSON files; consider limiting numbers of MD steps, like 20.
121122
- Currently this feature only supports single process, or multi-process runs where each process uses a distinct GPU on the same node.
122-
:::
123+
124+
:::

0 commit comments

Comments
 (0)