Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MaartenGr committed Oct 5, 2023
1 parent fb910ca commit 65db4d3
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/guides/keyllm.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ This data was chosen to show the different use cases and techniques. As you migh

Let's start with `KeyLLM` only.


# Use Cases

If you want the full performance and easiest method, you can skip the use cases below and go straight to number 5 where you will combine `KeyBERT` with `KeyLLM`.
Expand Down Expand Up @@ -180,6 +181,13 @@ If you have embeddings of your documents, you could use those to find documents
--8<-- "docs/images/efficient.svg"
</div>

!!! Tip
Before you get started, it might be worthwhile to uninstall sentence-transformers and re-install it from the main branch.
There is an issue with community detection (cluster) that might make the model run without finishing. It is as straightforward as:
`pip uninstall sentence-transformers`
`pip install --upgrade git+https://github.com/UKPLab/sentence-transformers`


```python
import openai
from keybert.llm import OpenAI
Expand Down Expand Up @@ -224,6 +232,13 @@ This is the best of both worlds. We use `KeyBERT` to generate a first pass of ke
--8<-- "docs/images/keybert_keyllm.svg"
</div>

!!! Tip
Before you get started, it might be worthwhile to uninstall sentence-transformers and re-install it from the main branch.
There is an issue with community detection (cluster) that might make the model run without finishing. It is as straightforward as:
`pip uninstall sentence-transformers`
`pip install --upgrade git+https://github.com/UKPLab/sentence-transformers`


```python
import openai
from keybert.llm import OpenAI
Expand Down

0 comments on commit 65db4d3

Please sign in to comment.