diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a806fa68c8..af9b5d926b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ and apply your changes there. > (a) The contribution was created in whole or in part by me and I > have the right to submit it under the open source license > indicated in the file; or -> +> > (b) The contribution is based upon previous work that, to the best > of my knowledge, is covered under an appropriate open source > license and I have the right under that license to submit that @@ -47,11 +47,11 @@ and apply your changes there. > by me, under the same open source license (unless I am > permitted to submit under a different license), as indicated > in the file; or -> +> > (c) The contribution was provided directly to me by some other > person who certified (a), (b) or (c) and I have not modified > it. -> +> > (d) I understand and agree that this project and the contribution > are public and that a record of the contribution (including all > personal information I submit with it, including my sign-off) is diff --git a/README.md b/README.md index f9e0345e99..bcd360abf3 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ contribution process. * Licensing information can be found in the [LICENSE](LICENSE) file. -## Development +## Development Omniperf follows a [main-dev](https://nvie.com/posts/a-successful-git-branching-model/) @@ -59,4 +59,3 @@ style reference is provided below for convenience: url = {https://doi.org/10.5281/zenodo.7314631} } ``` - diff --git a/src/docs-2.x/getting_started.md b/src/docs-2.x/getting_started.md index dc4d5e9eb0..986beae2ba 100644 --- a/src/docs-2.x/getting_started.md +++ b/src/docs-2.x/getting_started.md @@ -9,7 +9,7 @@ ## Quickstart 1. **Launch & Profile the target application with the command line profiler** - + The command line profiler launches the target application, calls the rocProfiler API via the rocProf binary, and collects profile results for the specified kernels, dispatches, and/or hardware components. If not specified, Omniperf will default to collecting all available counters for all kernels/dispatches launched by the user's executable. To collect the default set of data for all kernels in the target application, launch, e.g.: @@ -19,13 +19,13 @@ The app runs, each kernel is launched, and profiling results are generated. By default, results are written to e.g., ./workloads/vcopy_data (configurable via the `-n` argument). To collect all requested profile information, it may be required to replay kernels multiple times. 2. **Customize data collection** - + Options are available to specify for which kernels/metrics data should be collected. Note that filtering can be applied either in the profiling or analysis stage, however filtering at during profiling collection will often speed up your overall profiling run time. Some common filters include: - - `-k`/`--kernel` enables filtering kernels by name. + - `-k`/`--kernel` enables filtering kernels by name. - `-d`/`--dispatch` enables filtering based on dispatch ID. - `-b`/`--block` enables collects metrics for only the specified (one or more) hardware component blocks. @@ -35,7 +35,7 @@ ``` 3. **Analyze at the command line** - + After generating a local output folder (./workloads/\), the command line tool can also be used to quickly interface with profiling results. View different metrics derived from your profiled results and get immediate access all metrics organized by IP blocks. If no kernel, dispatch, or hardware block filters are applied at this stage, analysis will be reflective of the entirety of the profiling data. @@ -43,7 +43,7 @@ To interact with profiling results from a different session, users just provide the workload path. `-p`/`--path` enables users to analyze existing profiling data in the Omniperf CLI. 4. **Analyze in the Grafana GUI** - + To conduct a more in-depth analysis of profiling results we recommend users utilize the Omniperf Grafana GUI. To interact with profiling results, users must import their data to the MongoDB instance included in the Omniperf dockerfile. To interact with Grafana GUI data, stored in the Omniperf DB, users can enter ***database*** mode. For example: