Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update additional_configurations.md #926

Merged
merged 1 commit into from
May 28, 2024
Merged

Conversation

eltociear
Copy link
Contributor

@eltociear eltociear commented May 28, 2024

User description

Huggingface -> Hugging Face


PR Type

Documentation


Description

  • Corrected the spelling of "Huggingface" to "Hugging Face" throughout the additional_configurations.md documentation file.
  • Updated references to Hugging Face API keys and inference endpoints to ensure consistency and accuracy.

Changes walkthrough 📝

Relevant files
Documentation
additional_configurations.md
Corrected spelling of "Huggingface" to "Hugging Face" in documentation

docs/docs/usage-guide/additional_configurations.md

  • Corrected the spelling of "Huggingface" to "Hugging Face" throughout
    the document.
  • Updated references to Hugging Face API keys and inference endpoints.
  • +7/-7     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Huggingface -> Hugging Face
    @codiumai-pr-agent-pro codiumai-pr-agent-pro bot added documentation Improvements or additions to documentation Review effort [1-5]: 1 labels May 28, 2024
    Copy link
    Contributor

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    1, because the PR involves simple text replacements in documentation, which are straightforward to verify.

    🏅 Score

    95

    🧪 Relevant tests

    No

    ⚡ Possible issues

    No

    🔒 Security concerns

    No

    Copy link
    Contributor

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Clarity
    Use angle brackets to indicate placeholder values in example configurations

    Ensure that the example URLs and keys are clearly marked as placeholders by using angle
    brackets (e.g., ).

    docs/docs/usage-guide/additional_configurations.md [85-109]

    -api_base = ... # the base url for your Hugging Face inference endpoint
    -key = ... # your Hugging Face api key
    +api_base = <your-api-base-url> # the base url for your Hugging Face inference endpoint
    +key = <your-api-key> # your Hugging Face api key
     
    Suggestion importance[1-10]: 8

    Why: Using angle brackets for placeholders enhances clarity and prevents confusion, which is particularly important in configuration examples.

    8
    Readability
    Add blank lines around code blocks for better readability

    Add a blank line before and after code blocks to improve readability and ensure proper
    rendering in markdown.

    docs/docs/usage-guide/additional_configurations.md [67-69]

     E.g. to use a new Hugging Face model locally via Ollama, set:
    +

    [init.py]
    MAX_TOKENS = {

                       
    
    
    <details><summary><b>Suggestion importance[1-10]: 7</b></summary>
    
    Why: Adding blank lines around code blocks can indeed improve readability and markdown rendering, which is a good practice, though not critical.
    
    
    </details></details></td><td align=center>7
    
    </td></tr><tr><td rowspan=1><strong>Context</strong></td>
    <td>
    
    
    
    <details><summary>Add an introductory sentence to the "Local" section for better context</summary>
    
    ___
    
    
    **Add a brief introductory sentence before the "Local" section to provide context on what <br>the section covers.**
        
    [docs/docs/usage-guide/additional_configurations.md [64-65]](https://github.com/Codium-ai/pr-agent/pull/926/files#diff-9290a3ad9a86690b31f0450b77acd37ef1914b41fabc8a08682d4da433a77f90R64-R65)
    
    ```diff
     **Local**
    +The following instructions will guide you on how to run Hugging Face models locally.
     You can run Hugging Face models locally through either [VLLM](https://docs.litellm.ai/docs/providers/vllm) or [Ollama](https://docs.litellm.ai/docs/providers/ollama)
     
    
    Suggestion importance[1-10]: 6

    Why: Adding an introductory sentence can improve the context and understanding of the section, enhancing the document's usability and readability.

    6

    @mrT23
    Copy link
    Collaborator

    mrT23 commented May 28, 2024

    always happy to enhance our documentation 👍

    @mrT23 mrT23 merged commit 806ba3f into Codium-ai:main May 28, 2024
    1 check passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants