Skip to content

Commit

Permalink
Removed irrelevant information about setfit in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
x-tabdeveloping committed Aug 22, 2024
1 parent bcb08a1 commit f8d2e08
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 9 deletions.
8 changes: 2 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,9 @@ Stormtrooper is a lightweight Python library for zero and few-shot classificatio
You can install stormtrooper from PyPI.

```
pip install stormtrooper[torch]
pip install stormtrooper
```

If you intend to use SetFit models as well, install stormtrooper with optional dependencies.

```
pip install stormtrooper[setfit]
```
From version 0.4.0 you can also use OpenAI models in stormtrooper.
Expand Down Expand Up @@ -111,7 +107,7 @@ As such, you have to put templated names in brackets.
To run models locally on a GPU, you can use the `device` attribute of stormtrooper models.

```python
model = Trooper("sentence-transformers/all-MiniLM-L6-v2", device="cuda")
model = Trooper("all-MiniLM-L6-v2", device="cuda")
```

## API Reference
Expand Down
4 changes: 1 addition & 3 deletions docs/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,10 @@ It involves:

When you load any encoder-style model in Stormtrooper, they are automatically converted into a SetFit model.

> You have to `pip install setfit` for this to work.
```python
from stormtrooper import Trooper

model = Trooper("sentence-transformers/all-MiniLM-L6-v2")
model = Trooper("all-MiniLM-L6-v2")
```

::: stormtrooper.set_fit.SetFitClassifier
Expand Down

0 comments on commit f8d2e08

Please sign in to comment.