Skip to content

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

Open
@milvus-grammar-checker

Description

@milvus-grammar-checker

Document Path

grammar_test/embed-with-bgm-m3.md

Analysis Result

  1. Issue: Redundant phrasing
    Location: Line 2
    Original: "BGE M3 is named for its capabilities in Multi-Linguality, Multi-Functionality, and Multi-Granularity."
    Suggestion: "BGE M3 is named for its capabilities in multilinguality, functionality, and granularity." (Consider using lowercase for consistency and to align with standard terminology.)

  2. Issue: Awkward phrasing
    Location: Line 3
    Original: "Capable of supporting over 100 languages, BGE-M3 sets new benchmarks in multi-lingual and cross-lingual retrieval tasks."
    Suggestion: "With the capability to support over 100 languages, BGE-M3 sets new benchmarks in multilingual and cross-lingual retrieval tasks." (This rephrasing improves clarity and flow.)

  3. Issue: Inconsistent terminology
    Location: Line 4
    Original: "Its unique ability to perform dense retrieval, multi-vector retrieval, and sparse retrieval within a single framework makes it an ideal choice for a wide range of information retrieval (IR) applications."
    Suggestion: "Its unique ability to perform dense, multi-vector, and sparse retrieval within a single framework makes it an ideal choice for a wide range of information retrieval (IR) applications." (Removing the repetition of "retrieval" enhances readability.)

  4. Issue: Awkward phrasing
    Location: Line 6
    Original: "This class handles the computation of embeddings and returns them in a format compatible with Milvus for indexing and searching."
    Suggestion: "This class computes embeddings and returns them in a format compatible with Milvus for indexing and searching." (Simplifying the phrasing improves clarity.)

  5. Issue: Redundant phrasing
    Location: Line 8
    Original: "To use this feature, FlagEmbedding must be installed."
    Suggestion: "To use this feature, install FlagEmbedding." (This makes the instruction more direct.)

  6. Issue: Awkward phrasing
    Location: Line 10
    Original: "To create embeddings for documents, use the encode_documents() method:"
    Suggestion: "To create document embeddings, use the encode_documents() method:" (This rephrasing is more concise and natural.)

  7. Issue: Awkward phrasing
    Location: Line 14
    Original: "To create embeddings for queries, use the encode_queries() method:"
    Suggestion: "To create query embeddings, use the encode_queries() method:" (Similar to the previous suggestion, this improves conciseness.)

No additional issues were found in the remaining lines.

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