Skip to content

Commit

Permalink
chore: remove extraneous folder in specs (#1048)
Browse files Browse the repository at this point in the history
* 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
jonathanpwang authored Dec 15, 2024
1 parent 705abe7 commit c19c9ac
Show file tree
Hide file tree
Showing 14 changed files with 115 additions and 131 deletions.
74 changes: 37 additions & 37 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[workspace.package]
version = "0.1.0"
version = "0.1.0-alpha"
edition = "2021"
rust-version = "1.82"
authors = ["Intrinsic Technologies"]
Expand Down
49 changes: 3 additions & 46 deletions README.md
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)
Binary file added assets/modularity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion assets/modularity.svg

This file was deleted.

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ This directory contains documentation for contributors.
- [Design and Specification](./specs)
- [Crates](./crates)

![](../assets/modularity.svg)
![](../assets/modularity.png)
Loading

0 comments on commit c19c9ac

Please sign in to comment.