Skip to content

Commit e16c47a

Browse files
fix text
1 parent 93964b6 commit e16c47a

File tree

3 files changed

+71
-7
lines changed

3 files changed

+71
-7
lines changed

testable-simd-models/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ The structure of this crate is based on [rust-lang/stdarch/crates/core_arch](htt
88
Within the `core_arch` folder in this crate, there is a different
99
folder for each architecture for which we have wrtten models.
1010
In particular, it contains folders for `x86` and `arm_shared`.
11-
Each such folder has 3 sub-folders, `models`, `tests`, and `specs`.
11+
Each such folder has 2 sub-folders: `models` and `tests`.
1212

13-
The `models` folder contains the models of the intrinsics, with a file
14-
corresponding to different target features, and are written using the
15-
various abstractions implemented in `crate::abstractions`, especially
16-
those in `crate::abstractions::simd`. These models are meant to
17-
closely resemble their implementations within the Rust core itself.
13+
The `models` folder contains the models of the intrinsics, with
14+
different files for different target features (e.g. `sse2`, `avx2`
15+
etc.). The code in this folder is written using the various
16+
abstractions implemented in `abstractions`, especially those in
17+
`abstractions::simd`. These models are meant to closely
18+
resemble their implementations within the Rust core itself.
1819

1920
The `tests` folder contains the tests of these models, and is
2021
structured the same way as `models`. Each file additionally contains
@@ -23,7 +24,8 @@ tests work by testing the models against the intrinsics in the Rust
2324
core, trying out random inputs (generally 1000), and comparing their
2425
outputs.
2526

26-
The tests can run by executing `cargo test`.
27+
All tests can run by executing `cargo test` and we expect this to be
28+
run as part of CI.
2729

2830
## Modeling a SIMD Intrinsic
2931

0 commit comments

Comments
 (0)