Skip to content

Commit

Permalink
Update typos and clarify python files note supported
Browse files Browse the repository at this point in the history
  • Loading branch information
saulshanabrook committed Mar 31, 2022
1 parent 40ba42e commit c6c1446
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,12 +370,12 @@ The [Docker](https://github.com/LineaLabs/lineapy/blob/main/Dockerfile) and [mak
### 4.5. Benchmarking

We provide a benchmarking command to test how much lineapy impacts the performance. To use it,
pass in the path to a notebook or Python file (which does not import lineapy) to `lineapy benchmark` and lineapy will try it multiple time and report some stastics (using the method
pass in the path to a notebook (which does not import lineapy) to `lineapy benchmark` and lineapy will try it multiple time and report some stastics (using the method
described in the paper ["Quantifying Performance Changes with Effect Size Confidence
Interval"](https://www.cs.kent.ac.uk/pubs/2012/3233/content.pdf)) by Tomas Kalibera and Richard Jones).

```bash
$ cd tests/integrations
$ cd tests/integration
# First run the test, to create the conda env for the tensorflow notebook
$ pytest 'test_slice.py::test_slice[tensorflow_preprocessing_layers]' -m integration
# Then activate the environment
Expand Down
2 changes: 1 addition & 1 deletion lineapy/cli/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ def validate_benchmark_path(ctx, param, value: pathlib.Path):
)
def benchmark(path: pathlib.Path, n: int, skip_baseline: bool):
"""
Benchmarks running the file or notebook at PATH with lineapy versus with pure Python.
Benchmarks running the notebook at PATH with lineapy versus with pure Python.
Runs with and without lineapy REPETITIONS times.
Prints the length of each run, and some statistics if they are meanifully different.
Expand Down

0 comments on commit c6c1446

Please sign in to comment.