Skip to content

Commit 06d79c4

Browse files
emerybergerclaude
andcommitted
Update docs to reflect coz plot auto-loading profiles
- coz plot now automatically opens profile.coz in the browser - Consolidate and simplify viewer documentation - Update sample applications section 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 9f609fc commit 06d79c4

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,11 +118,9 @@ A number of the benchmarks are from the Phoenix benchmark suite, and several req
118118

119119
### Viewer
120120

121-
After profiling, open the results locally (`coz plot`, which launches the bundled HTML UI) or visit [https://coz-profiler.github.io/coz-ui/](https://coz-profiler.github.io/coz-ui/) and drop in your `profile.coz`.
121+
After profiling, run `coz plot` to automatically open your results in the browser. If you're on a remote system, transfer `profile.coz` to your local machine and visit [https://coz-profiler.github.io/coz-ui/](https://coz-profiler.github.io/coz-ui/) to load it.
122122

123-
If you are on a remote system, you can open the Coz viewer in your browser: [https://coz-profiler.github.io/coz-ui/](https://coz-profiler.github.io/coz-ui/) and then load the file `profile.coz`, which you will have to transfer to your local machine.
124-
125-
(You may need to move the "Minimum Points" slider on the left side to see the results.)
123+
You may need to adjust the "Minimum Points" slider to see results if the profile has limited data.
126124

127125
## Using Coz
128126
Using Coz requires a small amount of setup, but you can jump ahead to the section on the included [sample applications](#sample-applications) in this repository if you want to try Coz right away.
@@ -150,7 +148,7 @@ When coz tests a hypothetical optimization it will report the effect of that opt
150148
Coz has command line options to specify progress points when profiling the application instead of modifying its source. This feature is currently disabled because it did not work particularly well. Adding support for better command line-specified progress points is planned in the near future.
151149

152150
## Processing Results
153-
Run `coz plot` to launch a local web server and open the viewer in your browser. Alternatively, visit [https://coz-profiler.github.io/coz-ui/](https://coz-profiler.github.io/coz-ui/) and load your `profile.coz` file. The online viewer also includes sample profiles from PARSEC benchmarks.
151+
Run `coz plot` to launch a local web server and automatically open your profile in the browser. For remote systems, visit [https://coz-profiler.github.io/coz-ui/](https://coz-profiler.github.io/coz-ui/) and load your `profile.coz` file. The online viewer also includes sample profiles from PARSEC benchmarks.
154152

155153
## Sample Applications
156154
The `benchmarks/` directory includes several small programs with progress points already wired up. Once you configure with `-DBUILD_BENCHMARKS=ON` (see above), you can run them straight from the build tree:
@@ -160,7 +158,7 @@ The `benchmarks/` directory includes several small programs with progress points
160158
coz run --- ./build-bench/benchmarks/toy/toy
161159
```
162160

163-
These programs may need several runs before Coz accumulates enough samples to emit a useful profile. Upload `profile.coz` to the viewer when you are done.
161+
These programs may need several runs before Coz accumulates enough samples to emit a useful profile. Run `coz plot` to view the results.
164162

165163
## CMake
166164
When you install coz it installs a cmake config file. To add coz to a cmake project simply use the command `find_package(coz-profiler)`. This will import a target for the library and includes called `coz::coz` and a target for the coz binary `coz::profiler`. For guidance on how to use these targets refer to the CMake documentation.

0 commit comments

Comments
 (0)