From f8d2e080e3888bad552fcd5e9553410f6b7279bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?M=C3=A1rton=20Kardos?= Date: Thu, 22 Aug 2024 15:07:57 +0200 Subject: [PATCH] Removed irrelevant information about setfit in docs --- docs/index.md | 8 ++------ docs/models.md | 4 +--- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index e2227a8..742a5c2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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. @@ -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 diff --git a/docs/models.md b/docs/models.md index b23ab72..969e286 100644 --- a/docs/models.md +++ b/docs/models.md @@ -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