From ab36da919e4794dc38b83b009bffe3491b234209 Mon Sep 17 00:00:00 2001 From: Tom Aarsen Date: Wed, 15 Jan 2025 13:10:20 +0100 Subject: [PATCH] Update the ToC --- static-embeddings.md | 89 +++++++++++++++++++++++--------------------- 1 file changed, 46 insertions(+), 43 deletions(-) diff --git a/static-embeddings.md b/static-embeddings.md index 366a329859..944b02e288 100644 --- a/static-embeddings.md +++ b/static-embeddings.md @@ -79,49 +79,52 @@ print(similarities) ## Table of Contents -* [TL;DR](#tl-dr) -* [Table of Contents](#table-of-contents) -* [What are Embeddings?](#what-are-embeddings) - + [Modern Embeddings](#modern-embeddings) - + [Static Embeddings](#static-embeddings) -* [Training Details](#training-details) - + [Training Requirements](#training-requirements) - + [Model Inspiration](#model-inspiration) - + [Training Dataset Selection](#training-dataset-selection) - - [English Retrieval](#english-retrieval) - - [Multilingual Similarity](#multilingual-similarity) - - [Code](#code) - + [Loss Function Selection](#loss-function-selection) - - [Code](#code-1) - - [Matryoshka Representation Learning](#matryoshka-representation-learning) - * [Code](#code-2) - + [Training Arguments Selection](#training-arguments-selection) - - [Code](#code-3) - + [Evaluator Selection](#evaluator-selection) - - [Code](#code-4) - + [Hardware Details](#hardware-details) - + [Overall Training Scripts](#overall-training-scripts) - - [English Retrieval](#english-retrieval-1) - - [Multilingual Similarity](#multilingual-similarity-1) -* [Usage](#usage) - + [English Retrieval](#english-retrieval-2) - + [Multilingual Similarity](#multilingual-similarity-2) - + [Matryoshka Dimensionality Truncation](#matryoshka-dimensionality-truncation) - + [Third Party libraries](#third-party-libraries) - - [LangChain](#langchain) - - [LlamaIndex](#llamaindex) - - [Haystack](#haystack) - - [txtai](#txtai) -* [Performance](#performance) - + [English Retrieval](#english-retrieval-3) - - [NanoBEIR](#nanobeir) - * [GPU](#gpu) - * [CPU](#cpu) - - [Matryoshka Evaluation](#matryoshka-evaluation) - + [Multilingual Similarity](#multilingual-similarity-3) - - [Matryoshka Evaluation](#matryoshka-evaluation-1) -* [Conclusion](#conclusion) -* [Next Steps](#next-steps) +- [TL;DR](#tl-dr) +- [Table of Contents](#table-of-contents) +- [What are Embeddings?](#what-are-embeddings) + * [Modern Embeddings](#modern-embeddings) + * [Static Embeddings](#static-embeddings) +- [Our Method](#our-method) +- [Training Details](#training-details) + * [Training Requirements](#training-requirements) + * [Model Inspiration](#model-inspiration) + + [English Retrieval](#english-retrieval) + + [Multilingual Similarity](#multilingual-similarity) + * [Training Dataset Selection](#training-dataset-selection) + + [English Retrieval](#english-retrieval-1) + + [Multilingual Similarity](#multilingual-similarity-1) + + [Code](#code) + * [Loss Function Selection](#loss-function-selection) + + [Code](#code-1) + + [Matryoshka Representation Learning](#matryoshka-representation-learning) + - [Code](#code-2) + * [Training Arguments Selection](#training-arguments-selection) + + [Code](#code-3) + * [Evaluator Selection](#evaluator-selection) + + [Code](#code-4) + * [Hardware Details](#hardware-details) + * [Overall Training Scripts](#overall-training-scripts) + + [English Retrieval](#english-retrieval-2) + + [Multilingual Similarity](#multilingual-similarity-2) +- [Usage](#usage) + * [English Retrieval](#english-retrieval-3) + * [Multilingual Similarity](#multilingual-similarity-3) + * [Matryoshka Dimensionality Truncation](#matryoshka-dimensionality-truncation) + * [Third Party libraries](#third-party-libraries) + + [LangChain](#langchain) + + [LlamaIndex](#llamaindex) + + [Haystack](#haystack) + - [txtai](#txtai) +- [Performance](#performance) + * [English Retrieval](#english-retrieval-4) + + [NanoBEIR](#nanobeir) + - [GPU](#gpu) + - [CPU](#cpu) + + [Matryoshka Evaluation](#matryoshka-evaluation) + * [Multilingual Similarity](#multilingual-similarity-4) + + [Matryoshka Evaluation](#matryoshka-evaluation-1) +- [Conclusion](#conclusion) +- [Next Steps](#next-steps) ## What are Embeddings?