docs: add EMBEDDINGS_TYPE valid options to README and .env.example#249
Open
YASHBHIWANIA wants to merge 1 commit intoThe-OpenROAD-Project:masterfrom
Open
docs: add EMBEDDINGS_TYPE valid options to README and .env.example#249YASHBHIWANIA wants to merge 1 commit intoThe-OpenROAD-Project:masterfrom
YASHBHIWANIA wants to merge 1 commit intoThe-OpenROAD-Project:masterfrom
Conversation
YASHBHIWANIA
force-pushed
the
fix/embeddings-type-documentation
branch
from
fc47c5f to
cfe1165
Compare
Signed-off-by: YASHBHIWANIA <yashbhiwania772@gmail.com>
YASHBHIWANIA
force-pushed
the
fix/embeddings-type-documentation
branch
from
cfe1165 to
c0ce39f
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
The
EMBEDDINGS_TYPEenvironment variable in.env.examplehad nodocumentation about its valid options. New contributors hitting an
invalid value would get a confusing
ValueErrorwith no guidanceon what values are accepted.
Changes
EMBEDDINGS_TYPEinbackend/.env.examplelisting valid options:
HF,GOOGLE_GENAI,GOOGLE_VERTEXAIREADME.md(both Docker and local setup sections)explaining valid values and their requirements
Motivation
Encountered this issue while setting up ORAssistant locally —
the error message says valid options but the docs don't mention
them at all. This helps new contributors avoid the same confusion.
Relates to #248