-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: remove extraneous folder in specs (#1048)
* chore: remove extraneous folder in specs * chore: remove internal doc * fix: memory adapters * chore: comment out unused * chore: move benchmark readme * chore: update diagram
- Loading branch information
1 parent
705abe7
commit c19c9ac
Showing
14 changed files
with
115 additions
and
131 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,49 +1,6 @@ | ||
# OpenVM | ||
|
||
**Install** | ||
| User Book | ||
[**Install**](https://book.openvm.dev/getting-started/install.html) | ||
| [User Book](https://book.openvm.dev) | ||
| [Contributor Docs](./docs) | ||
| Crate Docs | ||
|
||
## Benchmarks | ||
|
||
To run benchmarks, install python3 and run: | ||
|
||
```bash | ||
python ci/scripts/bench.py <name> | ||
``` | ||
|
||
where `<name>` is a benchmark implemented as a rust binary (located in `src/bin` in a crate). Current benchmark options are: | ||
|
||
- `verify_fibair` | ||
- `fibonacci` | ||
- `regex` | ||
in the `benchmarks` crate. | ||
The benchmark outputs a JSON of metrics. You can process this into markdown with: | ||
|
||
```bash | ||
python ci/scripts/metric_unify/main.py <path to json> | ||
``` | ||
|
||
Currently the processing is done automatically at the end of `bench.py`. The script automatically detects if you have a previously saved metric file for the same benchmark and includes the diff report in the output. | ||
|
||
### Flamegraphs | ||
|
||
Flamegraphs to visualize the metrics collected by the VM cycle tracker can be generated if you have [inferno-flamegraph](https://crates.io/crates/inferno) installed. Install via | ||
|
||
```bash | ||
cargo install inferno | ||
``` | ||
|
||
Then run | ||
|
||
```bash | ||
python ci/scripts/metric_unify/flamegraph.py <path to json> | ||
``` | ||
|
||
The flamegraphs will be written to `*.svg` files in `.bench_metrics/flamegraphs` with respect to the repo root. | ||
|
||
### Latest Benchmark Results | ||
|
||
Latest benchmark results can be found [here](https://github.com/axiom-crypto/afs-prototype/blob/benchmark-results/index.md). | ||
These are run via [github workflows](./.github/workflows/benchmark-call.yml) and should always be up to date with the latest `main` branch. | ||
| [Crate Docs](https://docs.openvm.dev/openvm) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.