Docker: Production setup without Nginx
#159
Conversation
kaancayli
requested review from
krusche,
dfuchss,
bassner,
MichaelOwenDyer and
yassinsws
WalkthroughThe Changes
Possibly related PRs
Suggested labels
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (3)
README.MD (3)
121-122: Rephrase repetitive sentences in the Prerequisites section.In the Prerequisites section, the sentences starting with "Docker" and "Docker Compose" are repetitive. Consider rewording for better readability.
Tools
LanguageTool
[style] ~122-~122: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...p or install separately on Linux. #### Docker Compose Files - Development: `dock...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
208-208: Strengthen the wording in the Rebuild Containers section.The phrase "If you've made changes to the code or configurations" could be shortened to "After code or configuration changes" for conciseness.
Tools
LanguageTool
[style] ~208-~208: Consider shortening or rephrasing this to strengthen your wording.
Context: ... - Rebuild Containers If you've made changes to the code or configurations: ```bash ...(MAKE_CHANGES)
220-225: Adjust formatting for environment variable bullet points.The bullet points for environment variables might not render properly due to the colon immediately following the backticked code. Consider adding a space after the backticks or rephrasing to improve readability.
Tools
LanguageTool
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...nment variables: -PYRIS_DOCKER_TAG: Specifies the Pyris Docker image tag. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~221-~221: Loose punctuation mark.
Context: ...ge tag. -PYRIS_APPLICATION_YML_FILE: Path to yourapplication.ymlfile. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~222-~222: Loose punctuation mark.
Context: ...lfile. -PYRIS_LLM_CONFIG_YML_FILE: Path to yourllm-config.yml` file. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...llm-config.ymlfile. -PYRIS_PORT: Host port for Pyris application (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~224-~224: Loose punctuation mark.
Context: ...(default is8000). -WEAVIATE_PORT: Host port for Weaviate REST API (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~225-~225: Loose punctuation mark.
Context: ...ult is8001). -WEAVIATE_GRPC_PORT: Host port for Weaviate gRPC interface (...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
docker/pyris-production-internal.ymlis excluded by!**/*.yml
Files selected for processing (1)
- README.MD (1 hunks)
Additional context used
LanguageTool
README.MD
[style] ~122-~122: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...p or install separately on Linux. #### Docker Compose Files - Development: `dock...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~208-~208: Consider shortening or rephrasing this to strengthen your wording.
Context: ... - Rebuild Containers If you've made changes to the code or configurations: ```bash ...(MAKE_CHANGES)
[uncategorized] ~220-~220: Loose punctuation mark.
Context: ...nment variables: -PYRIS_DOCKER_TAG: Specifies the Pyris Docker image tag. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~221-~221: Loose punctuation mark.
Context: ...ge tag. -PYRIS_APPLICATION_YML_FILE: Path to yourapplication.ymlfile. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~222-~222: Loose punctuation mark.
Context: ...lfile. -PYRIS_LLM_CONFIG_YML_FILE: Path to yourllm-config.yml` file. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...llm-config.ymlfile. -PYRIS_PORT: Host port for Pyris application (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~224-~224: Loose punctuation mark.
Context: ...(default is8000). -WEAVIATE_PORT: Host port for Weaviate REST API (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~225-~225: Loose punctuation mark.
Context: ...ult is8001). -WEAVIATE_GRPC_PORT: Host port for Weaviate gRPC interface (...(UNLIKELY_OPENING_PUNCTUATION)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (4)
README.MD (4)
64-171: Excellent configuration guide!The guide for creating configuration files is very well-structured and informative. The instructions are clear, and the example configurations provide a good reference for users. The detailed explanation of the configuration parameters is particularly valuable.
One minor suggestion based on the static analysis hints: Consider adding a comma after "paths" in the sentence "Place your SSL certificate (
fullchain.pem) and private key (priv_key.pem) in the specified paths or update the paths in the Docker Compose file." to improve readability.Tools
LanguageTool
[uncategorized] ~149-~149: Loose punctuation mark.
Context: ...ameter Descriptions:** -api_key: The API key for the model. - `capa...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...key for the model. -capabilities: The capabilities of the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~152-~152: Loose punctuation mark.
Context: ...of the model. -context_length: The maximum number of tokens the model ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...quest. -gpt_version_equivalent: The equivalent GPT version of the model...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ...pabilities. -image_recognition: Whether the model supports image recogn...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~155-~155: Loose punctuation mark.
Context: ...ultimodal models). -input_cost: The cost of input tokens for the model....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~156-~156: Loose punctuation mark.
Context: ...ns for the model. -output_cost: The cost of output tokens for the model...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...kens for the model. -json_mode: Whether the model supports structured J...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~158-~158: Loose punctuation mark.
Context: ...tput mode. -privacy_compliance: Whether the model complies with privacy...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~159-~159: Loose punctuation mark.
Context: ...vacy regulations. -self_hosted: Whether the model is self-hosted. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ... model is self-hosted. -vendor: The provider of the model (e.g., OpenAI...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~161-~161: Loose punctuation mark.
Context: ...e model (e.g., OpenAI). -speed: The model's processing speed. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ... processing speed. -description: Additional information about the model....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~164-~164: Loose punctuation mark.
Context: ...information about the model. -id: Unique identifier for the model across ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~165-~165: Loose punctuation mark.
Context: ... model across all models. -model: The official name of the model as used ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...del as used by the vendor. -name: A custom, human-readable name for the m...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~167-~167: Loose punctuation mark.
Context: ...adable name for the model. -type: The model type, used to select the appr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~168-~168: Loose punctuation mark.
Context: ...zure_chat,ollama). -endpoint`: The URL to connect to the model. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...nnect to the model. -api_version: The API version to use with the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~170-~170: Loose punctuation mark.
Context: ...ith the model. -azure_deployment: The deployment name of the model on Azu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ...me of the model on Azure. -tools: The tools supported by the model. ...(UNLIKELY_OPENING_PUNCTUATION)
173-179: Helpful note ongpt_version_equivalent!The note provides valuable context for understanding the
gpt_version_equivalentparameter and how it's used to compare model capabilities. The examples are particularly useful for users to understand how to set this value for different models.One minor suggestion based on the static analysis hints: Consider removing the blank line inside the blockquote to adhere to the Markdown style guide.
Tools
Markdownlint
178-178: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
197-307: Comprehensive Docker setup guide!The Docker setup guide is excellent, providing clear and detailed instructions for both development and production environments. The inclusion of prerequisites, container management instructions, and customization options makes it a very comprehensive guide.
One minor suggestion based on the static analysis hints: Consider rephrasing the sentence "If you've made changes to the code or configurations:" to something more direct, like "After making changes to the code or configurations, rebuild the containers using the following command:".
Tools
LanguageTool
[uncategorized] ~244-~244: Possible missing comma found.
Context: ...e key (priv_key.pem) in the specified paths or update the paths in the Docker Compo...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~301-~301: Consider shortening or rephrasing this to strengthen your wording.
Context: ... - Rebuild Containers If you've made changes to the code or configurations: ```bash ...(MAKE_CHANGES)
308-344: Helpful troubleshooting guide!The troubleshooting guide is a valuable addition to the README, addressing common issues users may encounter when setting up or running Pyris. The instructions for resolving port conflicts and permission issues are clear and easy to follow, and the suggestion to ensure sufficient Docker resources is helpful.
One minor suggestion based on the static analysis hints: Consider adding a colon after "Port Conflicts", "Permission Issues", and "Docker Resources" to maintain consistency with the formatting of other headings in the document.
Tools
LanguageTool
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...nment variables: -PYRIS_DOCKER_TAG: Specifies the Pyris Docker image tag. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~314-~314: Loose punctuation mark.
Context: ...ge tag. -PYRIS_APPLICATION_YML_FILE: Path to yourapplication.ymlfile. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~315-~315: Loose punctuation mark.
Context: ...lfile. -PYRIS_LLM_CONFIG_YML_FILE: Path to yourllm-config.yml` file. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...llm-config.ymlfile. -PYRIS_PORT: Host port for Pyris application (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~317-~317: Loose punctuation mark.
Context: ...(default is8000). -WEAVIATE_PORT: Host port for Weaviate REST API (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~318-~318: Loose punctuation mark.
Context: ...ult is8001). -WEAVIATE_GRPC_PORT: Host port for Weaviate gRPC interface (...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (3)
application.example.ymlis excluded by!**/*.ymlapplication.test.ymlis excluded by!**/*.ymlllm_config.example.ymlis excluded by!**/*.yml
Files selected for processing (1)
- README.MD (1 hunks)
Additional context used
LanguageTool
README.MD
[uncategorized] ~149-~149: Loose punctuation mark.
Context: ...ameter Descriptions:** -api_key: The API key for the model. - `capa...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...key for the model. -capabilities: The capabilities of the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~152-~152: Loose punctuation mark.
Context: ...of the model. -context_length: The maximum number of tokens the model ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...quest. -gpt_version_equivalent: The equivalent GPT version of the model...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ...pabilities. -image_recognition: Whether the model supports image recogn...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~155-~155: Loose punctuation mark.
Context: ...ultimodal models). -input_cost: The cost of input tokens for the model....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~156-~156: Loose punctuation mark.
Context: ...ns for the model. -output_cost: The cost of output tokens for the model...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...kens for the model. -json_mode: Whether the model supports structured J...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~158-~158: Loose punctuation mark.
Context: ...tput mode. -privacy_compliance: Whether the model complies with privacy...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~159-~159: Loose punctuation mark.
Context: ...vacy regulations. -self_hosted: Whether the model is self-hosted. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ... model is self-hosted. -vendor: The provider of the model (e.g., OpenAI...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~161-~161: Loose punctuation mark.
Context: ...e model (e.g., OpenAI). -speed: The model's processing speed. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ... processing speed. -description: Additional information about the model....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~164-~164: Loose punctuation mark.
Context: ...information about the model. -id: Unique identifier for the model across ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~165-~165: Loose punctuation mark.
Context: ... model across all models. -model: The official name of the model as used ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...del as used by the vendor. -name: A custom, human-readable name for the m...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~167-~167: Loose punctuation mark.
Context: ...adable name for the model. -type: The model type, used to select the appr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~168-~168: Loose punctuation mark.
Context: ...zure_chat,ollama). -endpoint`: The URL to connect to the model. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...nnect to the model. -api_version: The API version to use with the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~170-~170: Loose punctuation mark.
Context: ...ith the model. -azure_deployment: The deployment name of the model on Azu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ...me of the model on Azure. -tools: The tools supported by the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Possible missing comma found.
Context: ...e key (priv_key.pem) in the specified paths or update the paths in the Docker Compo...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~301-~301: Consider shortening or rephrasing this to strengthen your wording.
Context: ... - Rebuild Containers If you've made changes to the code or configurations: ```bash ...(MAKE_CHANGES)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...nment variables: -PYRIS_DOCKER_TAG: Specifies the Pyris Docker image tag. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~314-~314: Loose punctuation mark.
Context: ...ge tag. -PYRIS_APPLICATION_YML_FILE: Path to yourapplication.ymlfile. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~315-~315: Loose punctuation mark.
Context: ...lfile. -PYRIS_LLM_CONFIG_YML_FILE: Path to yourllm-config.yml` file. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...llm-config.ymlfile. -PYRIS_PORT: Host port for Pyris application (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~317-~317: Loose punctuation mark.
Context: ...(default is8000). -WEAVIATE_PORT: Host port for Weaviate REST API (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~318-~318: Loose punctuation mark.
Context: ...ult is8001). -WEAVIATE_GRPC_PORT: Host port for Weaviate gRPC interface (...(UNLIKELY_OPENING_PUNCTUATION)
Markdownlint
README.MD
178-178: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
11-11: null
Link fragments should be valid(MD051, link-fragments)
17-17: null
Link fragments should be valid(MD051, link-fragments)
Additional comments not posted (5)
README.MD (5)
1-6: LGTM!The introduction provides a clear and concise overview of the Pyris project, its purpose, and its current application in powering Iris. It effectively communicates the key functionality of connecting Artemis with LLMs.
7-17: Great addition!The table of contents is a valuable addition to the README, providing a clear overview of the document's structure and making navigation much easier for readers. The links are properly formatted and cover all the important sections.
Tools
Markdownlint
11-11: null
Link fragments should be valid(MD051, link-fragments)
17-17: null
Link fragments should be valid(MD051, link-fragments)
21-25: Excellent feature overview!The feature list effectively communicates the key capabilities of Pyris, particularly in the context of the Artemis platform. The descriptions are clear and concise, making it easy for readers to understand the value Pyris provides.
29-62: Comprehensive setup guide!The local development setup guide is very well-written and comprehensive. It includes all the necessary steps, from prerequisites to running the server, with clear and detailed instructions. The use of code blocks for commands is a nice touch, making it easy for users to copy and execute them.
181-194: Important warning and clear instructions!The warning about the required
gpt_version_equivalentfor existing pipelines is crucial for users to ensure they define models correctly. The instructions for running the server and accessing the API documentation are clear and easy to follow, with the link to the documentation provided for convenience.
kaancayli
added
documentation
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
README.MD (3)
178-178: Remove Blank Line Inside BlockquoteThere's a blank line inside the blockquote, which can disrupt the formatting in Markdown. Please remove the blank line to maintain proper formatting.
Tools
Markdownlint
178-178: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
244-244: Add Comma Before "or" for ClarityConsider adding a comma before "or" to improve readability:
"Place your SSL certificate (
fullchain.pem) and private key (priv_key.pem) in the specified paths, or update the paths in the Docker Compose file."Tools
LanguageTool
[uncategorized] ~244-~244: Possible missing comma found.
Context: ...e key (priv_key.pem) in the specified paths or update the paths in the Docker Compo...(AI_HYDRA_LEO_MISSING_COMMA)
301-301: Strengthen Wording in 'Rebuild Containers' SectionTo make the instruction more direct, consider rephrasing the sentence:
"To rebuild the containers after code or configuration changes:"
Tools
LanguageTool
[style] ~301-~301: Consider shortening or rephrasing this to strengthen your wording.
Context: ... - Rebuild Containers If you've made changes to the code or configurations: ```bash ...(MAKE_CHANGES)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.MD (1 hunks)
Additional context used
LanguageTool
README.MD
[uncategorized] ~149-~149: Loose punctuation mark.
Context: ...ameter Descriptions:** -api_key: The API key for the model. - `capa...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...key for the model. -capabilities: The capabilities of the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~152-~152: Loose punctuation mark.
Context: ...of the model. -context_length: The maximum number of tokens the model ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~153-~153: Loose punctuation mark.
Context: ...quest. -gpt_version_equivalent: The equivalent GPT version of the model...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~154-~154: Loose punctuation mark.
Context: ...pabilities. -image_recognition: Whether the model supports image recogn...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~155-~155: Loose punctuation mark.
Context: ...ultimodal models). -input_cost: The cost of input tokens for the model....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~156-~156: Loose punctuation mark.
Context: ...ns for the model. -output_cost: The cost of output tokens for the model...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~157-~157: Loose punctuation mark.
Context: ...kens for the model. -json_mode: Whether the model supports structured J...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~158-~158: Loose punctuation mark.
Context: ...tput mode. -privacy_compliance: Whether the model complies with privacy...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~159-~159: Loose punctuation mark.
Context: ...vacy regulations. -self_hosted: Whether the model is self-hosted. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~160-~160: Loose punctuation mark.
Context: ... model is self-hosted. -vendor: The provider of the model (e.g., OpenAI...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~161-~161: Loose punctuation mark.
Context: ...e model (e.g., OpenAI). -speed: The model's processing speed. - `...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~163-~163: Loose punctuation mark.
Context: ... processing speed. -description: Additional information about the model....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~164-~164: Loose punctuation mark.
Context: ...information about the model. -id: Unique identifier for the model across ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~165-~165: Loose punctuation mark.
Context: ... model across all models. -model: The official name of the model as used ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~166-~166: Loose punctuation mark.
Context: ...del as used by the vendor. -name: A custom, human-readable name for the m...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~167-~167: Loose punctuation mark.
Context: ...adable name for the model. -type: The model type, used to select the appr...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~168-~168: Loose punctuation mark.
Context: ...zure_chat,ollama). -endpoint`: The URL to connect to the model. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~169-~169: Loose punctuation mark.
Context: ...nnect to the model. -api_version: The API version to use with the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~170-~170: Loose punctuation mark.
Context: ...ith the model. -azure_deployment: The deployment name of the model on Azu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ...me of the model on Azure. -tools: The tools supported by the model. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~244-~244: Possible missing comma found.
Context: ...e key (priv_key.pem) in the specified paths or update the paths in the Docker Compo...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~301-~301: Consider shortening or rephrasing this to strengthen your wording.
Context: ... - Rebuild Containers If you've made changes to the code or configurations: ```bash ...(MAKE_CHANGES)
[uncategorized] ~313-~313: Loose punctuation mark.
Context: ...nment variables: -PYRIS_DOCKER_TAG: Specifies the Pyris Docker image tag. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~314-~314: Loose punctuation mark.
Context: ...ge tag. -PYRIS_APPLICATION_YML_FILE: Path to yourapplication.ymlfile. ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~315-~315: Loose punctuation mark.
Context: ...lfile. -PYRIS_LLM_CONFIG_YML_FILE: Path to yourllm-config.yml` file. -...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~316-~316: Loose punctuation mark.
Context: ...llm-config.ymlfile. -PYRIS_PORT: Host port for Pyris application (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~317-~317: Loose punctuation mark.
Context: ...(default is8000). -WEAVIATE_PORT: Host port for Weaviate REST API (defaul...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~318-~318: Loose punctuation mark.
Context: ...ult is8001). -WEAVIATE_GRPC_PORT: Host port for Weaviate gRPC interface (...(UNLIKELY_OPENING_PUNCTUATION)
Markdownlint
README.MD
178-178: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
17-17: null
Link fragments should be valid(MD051, link-fragments)
Summary by CodeRabbit
README.MDfor improved clarity and navigation.