Skip to content

Commit e24a652

Browse files
Update README.md
1 parent e042854 commit e24a652

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
![MonthlyDownloads](https://static.pepy.tech/personalized-badge/vectorai-nightly?period=month&units=none&left_color=black&right_color=red&left_text=Monthly%20Downloads)
2727

2828
</div>
29-
29+
<hr>
3030

3131
<h3 align="center">
3232
Vector AI is a framework designed to make the process of building production grade vector based applications as quickly and easily as possible. Create, store, manipulate, search and analyse vectors alongside json documents to power applications such as neural search, semantic search, personalised recommendations recommendations etc.
@@ -38,7 +38,9 @@ Vector AI is a framework designed to make the process of building production gra
3838
- Join our discord: https://discord.gg/CbwUxyD
3939
- For a more gentle introduction comparing our features, read https://getvectorai.com/production-ready-search-in-5-minutes/
4040

41-
Features:
41+
<hr>
42+
43+
## Features
4244
- **Multimedia Data Vectorisation**: Image2Vec, Audio2Vec, etc (Any data can be turned into vectors through machine learning)
4345
- **Document Orientated Store**: Store your vectors alongside documents without having to do a db lookup for metadata about the vectors.
4446
- **Vector Similarity Search**: Enable searching of vectors and rich multimedia with vector similarity search. The backbone of many popular A.I use cases like reverse image search, recommendations, personalisation, etc.
@@ -49,13 +51,17 @@ Features:
4951
- **Clustering**: Interpret your vectors and data by allocating them to buckets and get statistics about these different buckets based on data you provide.
5052
- **Vector Analytics**: Get better understanding of your vectors by using out-of-the-box practical vector analytics, giving you better understanding of the quality of your vectors.
5153

54+
<hr>
55+
5256
## Quick Terminologies
5357

5458
- Models/Encoders (aka. Embedders) ~ Turns data into vectors e.g. Word2Vec turns words into vector
5559
- Vector Similarity Search (aka. Nearest Neighbor Search, Distance Search)
5660
- Collection (aka. Index, Table) ~ a collection is made up of multiple documents
5761
- Documents (aka. Json, Item, Dictionary, Row) ~ a document can contain vectors, text and links to videos/images/audio.
5862

63+
<hr>
64+
5965
## QuickStart
6066

6167
Install via pip! Compatible with any OS.
@@ -104,6 +110,8 @@ vi_client.search('test-collection', text_encoder.encode('maroon'), 'color_vector
104110
vi_client.search_by_id('test-collection', '1', 'color_vector_', page_size=2)
105111
```
106112

113+
<hr>
114+
107115
## Access Powerful Vector Analytics
108116

109117
Vector AI has powerful visualisations to allow you to analyse your vectors as easily as possible - in 1 line of code.
@@ -131,6 +139,8 @@ vi_client.plot_2d_cosine_similarity(
131139
Compare vectors and their search performance on your documents easily!
132140
![1D plot cosine simlarity](https://getvectorai.com/assets/gif/2d_cosine_similarity.gif)
133141

142+
<hr>
143+
134144
## Why Vector AI compared to other Nearest Neighbor implementations?
135145

136146
- **Production Ready**: Our API is fully managed and can scale to power hundreds of millions of searches a day. Even at millions of searches it is blazing fast through edge caching, GPU utilisation and software optimisation so you never have to worry about scaling your infrastructure as your use case scales.
@@ -140,7 +150,9 @@ Compare vectors and their search performance on your documents easily!
140150
- **Real time access to data**: Vector AI data is accessible in real time, as soon as the data is inserted it is searchable straight away. No need to wait hours to build an index.
141151
- **Framework agnostic**: We are never going to force a specific framework on Vector AI. If you have a framework of choice, you can use it - as long as your documents are JSON-serializable!
142152

143-
## Bring your own Model or Vector
153+
<hr>
154+
155+
### Bring your own Model or Vector
144156

145157
You can bring your own model or vectors and enjoy all the rich vector functionality that Vector AI provides.
146158

@@ -165,6 +177,8 @@ example_item = {
165177
}
166178
```
167179

180+
<hr>
181+
168182
## Building Products with Vector AI
169183
Creating a multi-language AI fashion assistant: https://fashionfiesta.me | [Blog](https://getvectorai.com/how-we-built-a-vector-powered-outfit-recommender/)
170184

0 commit comments

Comments
 (0)