docs: Update Features->Embeddings page to reflect backend restructuring #1325
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Marcus Köhler <khler.marcus@gmail.com>
✅ Deploy Preview for localai ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…d for consistency with the backend structure The Dockerfile still knows the "huggingface-embeddings" backend (I assume for compatibility reasons) but uses the sentencetransformers backend under the hood anyway. I figured it would be good to update the docs to use the new naming to make it less confusing moving forward. As the docker container knows both the "huggingface-embeddings" and the "sentencetransformers" backend, this should not break anything. Signed-off-by: Marcus Köhler <khler.marcus@gmail.com>
B4ckslash
force-pushed
the
website_embeddings_update
branch
from
b7acea9
to
9db7cfa
Compare
lunamidori5
added
the
kind/documentation
lunamidori5
approved these changes
Nov 24, 2023
@B4ckslash yes I think so, you are super welcome to make a how to page or edit the embedding one to add this if you like, or ill get one made asap |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The documentation website was out of date with regards to the path of the backend to run huggingface models. Since it moved to
backend/python/sentencetransformers, I updated the documentation accordingly so that people running LocalAI outside of Docker can continue to do so.I also changed the naming in the example YAML file to refer to the
sentencetransformersbackend instead of thehuggingface-embeddingsbackend. The docker version of LocalAI knows both as an alias for the same backend, so this should not break anything there.P.S.: Perhaps the docs should be updated to give an example on how to use the
transformersbackend as well? As I don't know what it is used for nor how one might use it, I wasn't able to include it in this PR.Notes for Reviewers
The renaming from
huggingface-embeddingstosentencetransformersis a separate commit, so if you don't like it, I can easily remove it from this PR.Signed commits