Add some metadata to the model card

#1
by tomaarsen HF Staff - opened

Hello!

Preface

Nice work here! I'm excited to see models of this size for RAG. I'm going to dive more into your official library next.

Pull Request overview

  • Add transformers tag
  • Add text-generation pipeline tag

Details

These should make it a tad easier to find this model.

Also, as a heads up, in my experience, a small snippet in the model card with usage is often recommended to get people a good feel of what your model does, e.g.:

rag = RAGWithCitations("PleIAs/Pleias-RAG-350M")

# Define query and sources
query = "What is the capital of France?"
sources = [
    {
        "text": "Paris is the capital and most populous city of France.",
        "metadata": {"source": "Geographic Encyclopedia", "reliability": "high"}
    },
    {
        "text": "The Eiffel Tower is located in Paris, France.",
        "metadata": {"source": "Travel Guide", "year": 2020}
    }
]

# Generate a response
response = rag.generate(query, sources)

# Print the final answer with citations
print(response["processed"]["clean_answer"])

(Except also include the import & printed output)

  • Tom Aarsen

Also, am I correct in understanding that this model should be applied after the Retrieval step in the RAG pipeline?

  • Tom Aarsen
PleIAs org

Yes exactly on all counts. It's not an embedding model (though a later iteration may come with some search capacities)

Pclanglais changed pull request status to merged
Your need to confirm your account before you can post a new comment.

Sign up or log in to comment