mirror of
https://github.com/exo-explore/exo.git
synced 2025-10-23 02:57:14 +03:00
clear instructions on formatting with yapf, remove linting
This commit is contained in:
14
README.md
14
README.md
@@ -222,6 +222,20 @@ For the **tinygrad** inference engine specifically, there is a separate DEBUG fl
|
||||
TINYGRAD_DEBUG=2 exo
|
||||
```
|
||||
|
||||
## Formatting
|
||||
|
||||
We use [yapf](https://github.com/google/yapf) to format the code. To format the code, first install the formatting requirements:
|
||||
|
||||
```sh
|
||||
pip3 install -e '.[formatting]'
|
||||
```
|
||||
|
||||
Then run the formatting script:
|
||||
|
||||
```sh
|
||||
python3 format.py ./exo
|
||||
```
|
||||
|
||||
## Known Issues
|
||||
|
||||
- On some versions of MacOS/Python, certificates are not installed properly which can lead to SSL errors (e.g. SSL error with huggingface.co). To fix this, run the Install Certificates command, usually:
|
||||
|
||||
@@ -21,7 +21,7 @@ def run_yapf(target):
|
||||
|
||||
def main():
|
||||
if len(sys.argv) < 2:
|
||||
print("Usage: python format.py <directory_or_file>")
|
||||
print("Usage: python3 format.py <directory_or_file> e.g. python3 format.py ./exo")
|
||||
sys.exit(1)
|
||||
|
||||
target = sys.argv[1]
|
||||
|
||||
Reference in New Issue
Block a user