From 1e5277fc24bda6fdce1aec4405d58be4841dc8a0 Mon Sep 17 00:00:00 2001 From: Tyler Mathis <35553152+tsmathis@users.noreply.github.com> Date: Mon, 12 Jun 2023 14:52:30 -0700 Subject: [PATCH] Add info to running builders docs for -md flag which allows user to specify output directory for memray --- docs/getting_started/running_builders.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/getting_started/running_builders.md b/docs/getting_started/running_builders.md index 54f07df7d..b2c5e19f3 100644 --- a/docs/getting_started/running_builders.md +++ b/docs/getting_started/running_builders.md @@ -138,4 +138,6 @@ The profiler will generate two files after the builder finishes: ***Note***: Different platforms/operating systems purge their system's `temp` directory at different intervals. It is recommended to move at least the `.bin` file to a more stable location. The `.bin` file can be used to recreate the flamegraph at anytime using the Memray CLI. +Using the flag `--memray-dir` (`-md`) allows for specifying an output directory for the `.bin` and `.html` files created by the profiler. The provided directory will be created if the directory does not exist, mimicking the `mkdir -p` command. + Further data visualization and transform examples can be found in Memray's documentation ([Memray reporters](https://bloomberg.github.io/memray/live.html)). \ No newline at end of file