Skip to content

Commit a408cdc

Browse files
authored
examples -> test in old tutorial readme
1 parent 7b57a9e commit a408cdc

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

docs/source/tutorial/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ pip install -r requirements.txt
8282

8383
You can try to run SLOTHY on one of the examples that come with SLOTHY to make sure it runs without errors:
8484
```
85-
python3 example.py --examples simple0
85+
python3 test.py --tests simple0_a55
8686
```
8787

8888
We will look into more examples shortly and discuss input, output, and available flags.
@@ -91,10 +91,10 @@ We will look into more examples shortly and discuss input, output, and available
9191

9292
The simplest way to get started using SLOTHY is by trying out some of the examples that come with SLOTHY.
9393
Once you work on your own code, you will likely be using the `slothy-cli` command or calling the SLOTHY module from your own Python script for invoking SLOTHY allowing you to control all the different options SLOTHY has.
94-
However, for now we will be using the [example.py](https://github.com/slothy-optimizer/slothy/blob/main/example.py) script and containing a number of examples including the ones we have optimized in the SLOTHY paper.
95-
You can run `python3 example.py --help` to see all examples available.
94+
However, for now we will be using the [test.py](https://github.com/slothy-optimizer/slothy/blob/main/test.py) script and containing a number of simple test cases. The examples targetedfor optimization in the SLOTHY paper can be accessed through a similarly structured [example.py](https://github.com/slothy-optimizer/slothy/blob/main/example.py).
95+
You can run `python3 test.py --help` to see all examples available.
9696

97-
Let's look at a very simple example from the previous section called `aarch64_simple0`.
97+
Let's look at a very simple case from the previous section called `aarch64_simple0`.
9898
You can find the corresponding code in [tests/naive/aarch64/aarch64_simple0.s](https://github.com/slothy-optimizer/slothy/blob/main/tests/naive/aarch64/aarch64_simple0.s):
9999
```asm
100100
ldr q0, [x1, #0]
@@ -133,9 +133,9 @@ Note, however, that SLOTHY has been used to also obtain significant speed-ups fo
133133

134134
SLOTHY comes with models for various Arm architectures, including the power-efficient, in-order
135135
[Cortex-A55](https://developer.arm.com/Processors/Cortex-A55), so we can now optimize this piece of code for that
136-
microarchitecture. [example.py](https://github.com/slothy-optimizer/slothy/blob/main/example.py) contains the needed SLOTHY incarnations for convenience, so we can simply run `python3
137-
example.py --examples aarch64_simple0_a55` which will optimize for the Cortex-A55 microarchitecture. You can check
138-
[example.py](https://github.com/slothy-optimizer/slothy/blob/main/example.py) for the details. This will optimize the piece of code above and write the output code to `examples/opt/aarch64/aarch64_simple0_opt_a55.s`.
136+
microarchitecture. [test.py](https://github.com/slothy-optimizer/slothy/blob/main/test.py) contains the needed SLOTHY incarnations for convenience, so we can simply run `python3
137+
test.py --tests aarch64_simple0_a55` which will optimize for the Cortex-A55 microarchitecture. You can check
138+
[test.py](https://github.com/slothy-optimizer/slothy/blob/main/test.py) for the details. This will optimize the piece of code above and write the output code to `test/opt/aarch64/aarch64_simple0_opt_a55.s`.
139139
SLOTHY should print something similar to this:
140140
```
141141
INFO:aarch64_simple0_a55:Instructions in body: 20
@@ -275,7 +275,7 @@ target = Target_CortexA55
275275
slothy = Slothy(arch, target)
276276

277277
# example
278-
slothy.load_source_from_file("examples/naive/aarch64/aarch64_simple0.s")
278+
slothy.load_source_from_file("tests/naive/aarch64/aarch64_simple0.s")
279279
slothy.config.variable_size=True
280280
slothy.config.constraints.stalls_first_attempt=32
281281

@@ -428,7 +428,7 @@ start:
428428

429429
Let's use SLOTHY to superoptimize this loop:
430430
```python
431-
slothy.load_source_from_file("examples/naive/aarch64/aarch64_simple0_loop.s")
431+
slothy.load_source_from_file("tests/naive/aarch64/aarch64_simple0_loop.s")
432432
slothy.config.variable_size=True
433433
slothy.config.constraints.stalls_first_attempt=32
434434

0 commit comments

Comments
 (0)