Skip to content

Commit

Permalink
update readme with instructions to run code_style.sh (#116)
Browse files Browse the repository at this point in the history
  • Loading branch information
ssusie authored Sep 30, 2024
1 parent e4b4205 commit 33bb598
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,18 @@ MaxDiffusion started as a fork of [Diffusers](https://github.com/huggingface/dif

Whether you are forking MaxDiffusion for your own needs or intending to contribute back to the community, a full suite of tests can be found in `tests` and `src/maxdiffusion/tests`.

To run unit tests and lint, simply run:
To run unit tests, simply run:
```
python -m pytest
ruff check --fix .
```

This project uses `pylint` and `pyink` to enforce code style. Before submitting a pull request, please ensure your code passes these checks by running:

```
bash code_style.sh
```

This script will automatically format your code with `pyink` and help you identify any remaining style issues.


The full suite of -end-to end tests is in `tests` and `src/maxdiffusion/tests`. We run them with a nightly cadance.

0 comments on commit 33bb598

Please sign in to comment.