Skip to content

Commit

Permalink
Update readme with test and installation info
Browse files Browse the repository at this point in the history
  • Loading branch information
w4ffl35 committed Oct 13, 2024
1 parent 657ae29 commit 300e912
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,22 @@ There are several ways to get started with AI Runner such as packaged, from sour

[Detailed packaging and installation instructions can be found in the wiki](https://github.com/Capsize-Games/airunner/wiki/Installation-instructions).

### Install as a library

Installation

```bash
pip install airunner
```

Running

```bash
airunner
```



---

## Models
Expand Down Expand Up @@ -129,6 +145,23 @@ Models must be placed in their respective directories in the `airunner` director

---

## Unit tests

Run all unit tests

```bash
python -m unittest discover -s src/airunner/tests
```

Run a single unit tests `python -m unittest src/airunner/tests/<file_name>`

Example
```bash
python -m unittest src/airunner/tests/test_prompt_weight_convert.py
```

---

## Privacy and Security

Although AI Runner v3.0 is built with Huggingface libraries, we have taken
Expand Down

0 comments on commit 300e912

Please sign in to comment.