update docs

lamalab-org · Oct 2, 2023 · 021bf90 · 021bf90
1 parent fa46652
commit 021bf90
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -899,3 +899,5 @@ FodyWeavers.xsd
 # End of https://www.toptal.com/developers/gitignore/api/macos,linux,windows,python,jupyternotebooks,jetbrains,pycharm,vim,emacs,visualstudiocode,visualstudio
 
 scratch/
+*.pkl
+*.db
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -19,6 +19,19 @@ Fine-tuning
 Classification 
 -----------------
 
+To handle the different model types, we provide a :code:`ChemLIFTClassifierFactory` that allows to easily create a classifier objects for the different model types.
+
+```python
+
+from chemlift.finetuning.classifier import ChemLIFTClassifierFactory
+
+model = ChemLIFTClassifierFactory('EleutherAI/gpt-neo-125m', load_in_8bit=False).create_model()
+model.fit(X, y)
+model.predict(X)
+```
+
+The model name can be any model name that is supported by the transformers library.
+In addition to that, we also support OpenAI models, if you prefix the model name with :code:`openai/`, e.g. :code:`openai/text-davinci-003`.
 
 
 Regression