Skip to content

Documentation improvement suggestion: embed-with-bgm-m3.md #3150

Open
@milvus-grammar-checker

Description

@milvus-grammar-checker

Document Path

grammar_test/embed-with-bgm-m3.md

Analysis Result

  1. Issue: Inconsistent use of hyphenation
    Location: Line 7
    Original: "BGE M3"
    Suggestion: "BGE-M3"

  2. Issue: Redundant sentence
    Location: Line 12
    Original: "To use this feature, FlagEmbedding must be installed."
    Suggestion: Remove this sentence as it is repeated in line 14.

  3. Issue: Missing punctuation
    Location: Line 14
    Original: "To use this feature, install the necessary dependencies:"
    Suggestion: "To use this feature, install the necessary dependencies."

  4. Issue: Missing instruction
    Location: Line 16
    Original: "Then, instantiate the BGEM3EmbeddingFunction:"
    Suggestion: "Then, instantiate the BGEM3EmbeddingFunction as follows:"

  5. Issue: Missing punctuation
    Location: Line 24
    Original: "To create embeddings for documents, use the encode_documents() method:"
    Suggestion: "To create embeddings for documents, use the encode_documents() method."

  6. Issue: Missing punctuation
    Location: Line 30
    Original: "To create embeddings for queries, use the encode_queries() method:"
    Suggestion: "To create embeddings for queries, use the encode_queries() method."

Please note that the feedback provided assumes that the missing code or instructions following the colons in the original text were intentionally omitted for this task. If they were not, additional feedback would be necessary to address the missing content.

Suggested Action

Please make corresponding modifications and optimizations to the documentation based on the above analysis results.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions