Merge pull request #1288 from qdrant/tutorials-section

[devportal] Create a Separate Tutorials Section
This commit is contained in:
David Myriel
2024-11-18 20:30:09 -08:00
committed by GitHub
19 changed files with 133 additions and 76 deletions
@@ -0,0 +1,18 @@
---
title: Advanced Retrieval
weight: 17
# If the index.md file is empty, the link to the section will be hidden from the sidebar
is_empty: false
aliases:
- how-to
- tutorials
partition: qdrant
---
# Advanced Tutorials
| |
|----------------------------------------------------------|
| [Use Collaborative Filtering to Build a Movie Recommendation System with Qdrant](/documentation/advanced-tutorials/collaborative-filtering/) |
| [Build a Text/Image Multimodal Search System with Qdrant and FastEmbed](/documentation/advanced-tutorials/multimodal-search-fastembed/) |
| [Navigate Your Codebase with Semantic Search and Qdrant](/documentation/advanced-tutorials/code-search/) |
@@ -1,9 +1,11 @@
---
title: Semantic code search
weight: 22
title: Search Through Your Codebase
aliases:
- /documentation/tutorials/code-search/
weight: 2
---
# Use semantic search to navigate your codebase
# Navigate Your Codebase with Semantic Search and Qdrant
| Time: 45 min | Level: Intermediate | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/qdrant/examples/blob/master/code-search/code-search.ipynb) | |
|--------------|---------------------|--|----|
@@ -1,13 +1,15 @@
---
title: Collaborative filtering
title: Build a Recommendation System with Collaborative Filtering
aliases:
- /documentation/tutorials/collaborative-filtering/
short_description: "Build an effective movie recommendation system using collaborative filtering and Qdrant's similarity search."
description: "Build an effective movie recommendation system using collaborative filtering and Qdrant's similarity search."
preview_image: /blog/collaborative-filtering/social_preview.png
social_preview_image: /blog/collaborative-filtering/social_preview.png
weight: 23
weight: 3
---
# Create a collaborative filtering system
# Use Collaborative Filtering to Build a Movie Recommendation System with Qdrant
| Time: 45 min | Level: Intermediate | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://githubtocolab.com/qdrant/examples/blob/master/collaborative-filtering/collaborative-filtering.ipynb) | |
|--------------|---------------------|--|----|
@@ -1,9 +1,11 @@
---
title: Multimodal Search
weight: 4
title: Setup Text/Image Multimodal Search
aliases:
- /documentation/tutorials/multimodal-search-fastembed/
weight: 1
---
# Multimodal Search with Qdrant and FastEmbed
# Build a Multimodal Search System with Qdrant and FastEmbed
| Time: 15 min | Level: Beginner |Output: [GitHub](https://github.com/qdrant/examples/blob/master/multimodal-search/Multimodal_Search_with_FastEmbed.ipynb)|[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://githubtocolab.com/qdrant/examples/blob/master/multimodal-search/Multimodal_Search_with_FastEmbed.ipynb) |
| --- | ----------- | ----------- | ----------- |
@@ -0,0 +1,21 @@
---
title: Vector Search Basics
aliases:
- /documentation/tutorials/
weight: 16
# If the index.md file is empty, the link to the section will be hidden from the sidebar
is_empty: false
aliases:
- how-to
- tutorials
partition: qdrant
---
# Beginner Tutorials
| |
|----------------------------------------------------|
| [Build Your First Semantic Search Engine in 5 Minutes](/documentation/beginner-tutorials/search-beginners/) |
| [Build a Neural Search Service with Sentence Transformers and Qdrant](/documentation/beginner-tutorials/neural-search/) |
| [Build a Hybrid Search Service with FastEmbed and Qdrant](/documentation/beginner-tutorials/hybrid-search-fastembed/) |
| [Measure and Improve Retrieval Quality in Semantic Search](/documentation/beginner-tutorials/retrieval-quality/) |
@@ -1,12 +1,11 @@
---
title: Hybrid Search with Fastembed
weight: 2
title: Setup Hybrid Search with FastEmbed
aliases:
- /documentation/tutorials/neural-search-fastembed/
- /documentation/tutorials/hybrid-search-fastembed/
weight: 3
---
# Create a Hybrid Search Service with Fastembed
# Build a Hybrid Search Service with FastEmbed and Qdrant
| Time: 20 min | Level: Beginner | Output: [GitHub](https://github.com/qdrant/qdrant_demo/) |
| --- | ----------- | ----------- |----------- |
@@ -1,22 +1,22 @@
---
title: Neural Search Service
weight: 1
title: Build a Neural Search Service
aliases:
- /documentation/tutorials/neural-search/
weight: 2
---
# Create a Simple Neural Search Service
# Build a Neural Search Service with Sentence Transformers and Qdrant
| Time: 30 min | Level: Beginner | Output: [GitHub](https://github.com/qdrant/qdrant_demo/tree/sentense-transformers) | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1kPktoudAP8Tu8n8l-iVMOQhVmHkWV_L9?usp=sharing) |
| --- | ----------- | ----------- |----------- |
This tutorial shows you how to build and deploy your own neural search service to look through descriptions of companies from [startups-list.com](https://www.startups-list.com/) and pick the most similar ones to your query. The website contains the company names, descriptions, locations, and a picture for each entry.
A neural search service uses artificial neural networks to improve the accuracy and relevance of search results. Besides offering simple keyword results, this system can retrieve results by meaning. It can understand and interpret complex search queries and provide more contextually relevant output, effectively enhancing the user's search experience.
<aside role="status">
There is a version of this tutorial that uses <a href="https://github.com/qdrant/fastembed">Fastembed</a> model inference engine instead of Sentence Transformers.
Check it out <a href="/documentation/tutorials/hybrid-search-fastembed/">here</a>.
Check it out <a href="/documentation/beginner-tutorials/hybrid-search-fastembed/">here</a>.
</aside>
@@ -1,9 +1,11 @@
---
title: Measure retrieval quality
weight: 21
title: Measure Search Quality
aliases:
- /documentation/tutorials/retrieval-quality/
weight: 4
---
# Measure retrieval quality
# Measure and Improve Retrieval Quality in Semantic Search
| Time: 30 min | Level: Intermediate | | |
|--------------|---------------------|--|----|
@@ -1,11 +1,12 @@
---
title: Semantic Search 101
weight: -100
weight: 1
aliases:
- /documentation/tutorials/mighty.md/
- /documentation/tutorials/search-beginners/
---
# Semantic Search for Beginners
# Build Your First Semantic Search Engine in 5 Minutes
| Time: 5 - 15 min | Level: Beginner | | |
| --- | ----------- | ----------- |----------- |
@@ -24,7 +24,7 @@ content:
title: Search
description: Build a simple neural search service with Qdrant and FastEmbed. Learn how to upload data, create indexes, and run search queries.
link:
url: /documentation/tutorials/hybrid-search-fastembed/
url: /documentation/beginner-tutorials/hybrid-search-fastembed/
text: Read More
- id: 2
image:
@@ -0,0 +1,19 @@
---
title: Using the Database
weight: 18
# If the index.md file is empty, the link to the section will be hidden from the sidebar
is_empty: false
aliases:
- how-to
- tutorials
partition: qdrant
---
# Database Tutorials
| |
|--------------------------------------------|
| [Bulk Upload Vectors to a Qdrant Collection](/documentation/database-tutorials/bulk-upload/) |
| [Backup and Restore Qdrant Collections Using Snapshots](/documentation/database-tutorials/create-snapshot/) |
| [Load and Search Hugging Face Datasets with Qdrant](/documentation/database-tutorials/huggingface-datasets/) |
| [Using Qdrant’s Async API for Efficient Python Applications](/documentation/database-tutorials/async-api/) |
@@ -1,9 +1,11 @@
---
title: Asynchronous API
weight: 14
title: Build With Async API
aliases:
- /documentation/tutorials/async-api/
weight: 4
---
# Using Qdrant asynchronously
# Using Qdrant’s Async API for Efficient Python Applications
Asynchronous programming is being broadly adopted in the Python ecosystem. Tools such as FastAPI [have embraced this new
paradigm](https://fastapi.tiangolo.com/async/), but it is also becoming a standard for ML models served as SaaS. For example, the Cohere SDK
@@ -1,9 +1,11 @@
---
title: Bulk Upload Vectors
weight: 13
aliases:
- /documentation/tutorials/bulk-upload/
weight: 1
---
# Bulk upload a large number of vectors
# Bulk Upload Vectors to a Qdrant Collection
Uploading a large-scale dataset fast might be a challenge, but Qdrant has a few tricks to help you with that.
@@ -1,9 +1,11 @@
---
title: Create and restore from snapshot
weight: 14
title: Create & Restore Snapshots
aliases:
- /documentation/tutorials/create-snapshot/
weight: 2
---
# Create and restore collections from snapshot
# Backup and Restore Qdrant Collections Using Snapshots
| Time: 20 min | Level: Beginner | | |
|--------------|-----------------|--|----|
@@ -1,9 +1,11 @@
---
title: Load Hugging Face dataset
weight: 19
title: Load a HuggingFace Dataset
aliases:
- /documentation/tutorials/huggingface-datasets/
weight: 3
---
# Loading a dataset from Hugging Face hub
# Load and Search Hugging Face Datasets with Qdrant
[Hugging Face](https://huggingface.co/) provides a platform for sharing and using ML models and
datasets. [Qdrant](https://huggingface.co/Qdrant) also publishes datasets along with the
@@ -0,0 +1,11 @@
---
#Delimiter files are used to separate the list of documentation pages into sections.
title: "Tutorials"
type: delimiter
weight: 15 # Change this weight to change order of sections
sitemapExclude: True
_build:
publishResources: false
render: never
partition: qdrant
---
@@ -1,28 +0,0 @@
---
title: Tutorials
weight: 10
# If the index.md file is empty, the link to the section will be hidden from the sidebar
is_empty: false
aliases:
- how-to
- tutorials
partition: qdrant
---
# Tutorials
These tutorials demonstrate different ways you can build vector search into your applications.
| Essential How-Tos | Description | Stack |
|---------------------------------------------------------------------------------|-------------------------------------------------------------------|---------------------------------------------|
| [Semantic Search for Beginners](/documentation/tutorials/search-beginners/) | Create a simple search engine locally in minutes. | Qdrant |
| [Simple Neural Search](/documentation/tutorials/neural-search/) | Build and deploy a neural search that browses startup data. | Qdrant, BERT, FastAPI |
| [Neural Search with FastEmbed](/documentation/tutorials/neural-search-fastembed/) | Build and deploy a neural search with our FastEmbed library. | Qdrant |
| [Multimodal Search](/documentation/tutorials/multimodal-search-fastembed/) | Create a simple multimodal search. | Qdrant |
| [Bulk Upload Vectors](/documentation/tutorials/bulk-upload/) | Upload a large scale dataset. | Qdrant |
| [Asynchronous API](/documentation/tutorials/async-api/) | Communicate with Qdrant server asynchronously with Python SDK. | Qdrant, Python |
| [Create Dataset Snapshots](/documentation/tutorials/create-snapshot/) | Turn a dataset into a snapshot by exporting it from a collection. | Qdrant |
| [Load HuggingFace Dataset](/documentation/tutorials/huggingface-datasets/) | Load a Hugging Face dataset to Qdrant | Qdrant, Python, datasets |
| [Measure Retrieval Quality](/documentation/tutorials/retrieval-quality/) | Measure and fine-tune the retrieval quality | Qdrant, Python, datasets |
| [Search Through Code](/documentation/tutorials/code-search/) | Implement semantic search application for code search tasks | Qdrant, Python, sentence-transformers, Jina |
| [Setup Collaborative Filtering](/documentation/tutorials/collaborative-filtering/) | Implement a collaborative filtering system for recommendation engines | Qdrant|