Welcome to Golden-Retriever’s documentation!

This is the technical documentation on Golden-Retriever’s API. For more narrative walkthroughs of Golden-Retriever or example use cases, check out our github repo and our information page and our demo.

Reference:

• GoldenRetriever’s Models
  • Encoders
  • GoldenRetriever Class
  • Loss Functions
  • Prebuilt Index
• Finetuning GoldenRetriever
  • Evaluation methods
  • Finetuning Triplet Generators
• Data Handlers
  • Elasticsearch Interface
  • Knowledge Base Handler
• GoldenRetriever’s API Functions

Indices and tables

• Index
• Module Index
• Search Page