Skip to content

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

@milvus-grammar-checker

Description

@milvus-grammar-checker

Document Path

grammar_test/embed-with-bgm-m3.md

Analysis Result

  1. Issue: Awkward 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 multilingualism, multifunctionality, and multi-granularity."

  2. Issue: Redundant phrasing
    Location: Line 4
    Original: "Capable of supporting over 100 languages, BGE-M3 sets new benchmarks in multi-lingual and cross-lingual retrieval tasks."
    Suggestion: "Supporting over 100 languages, BGE-M3 sets new benchmarks in multilingual and cross-lingual retrieval tasks."

  3. Issue: Awkward phrasing
    Location: Line 5
    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."

  4. Issue: Redundant phrasing
    Location: Line 8
    Original: "To use this feature, FlagEmbedding must be installed."
    Suggestion: "To use this feature, you must install FlagEmbedding."

  5. 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:"

  6. 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:"

No other issues found.

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