← Back to README

Stormlog Documentation

Stormlog ships three surfaces that should be treated as one workflow:

Use the guides below based on the job you are doing, not based on package internals.

Important: Pip vs Source Checkout

If you installed Stormlog via pip install stormlog (from PyPI):

The examples/ package is not included. Commands like python -m examples.cli.quickstart will fail with ModuleNotFoundError.
Use the CLI commands and Python snippets in this documentation instead. The gpumemprof, tfmemprof, and jaxmemprof CLIs and the public Python APIs work with a pip install.
Install stormlog[tui,torch] if you want the stormlog TUI entrypoint from a pip install.
The TUI Capability Matrix and OOM scenario buttons run example modules. If those fail, use the inline command runner in the TUI with the equivalent CLI commands from this guide.

If you cloned the repository and installed with pip install -e .:

You have access to the examples/, tests/, and docs/ source trees. The example modules and scenario runners will work.

Guides

docs/_build/ is generated output and not maintained as source documentation.
When docs and code disagree, treat the code and --help output as the source of truth and update the docs.