chroma README

The project's README from github.com/chroma-core/chroma. As one markdown file: README.md.

Chroma Chroma

Chroma - the open-source data infrastructure for AI.

Discord | License | Docs | Homepage

pip install chromadb # python client
# for javascript, npm install chromadb!
# for client-server mode, chroma run --path /chroma_db_path

Chroma Cloud

Our hosted service, Chroma Cloud, powers serverless vector, hybrid, and full-text search. It's extremely fast, cost-effective, scalable and painless. Create a DB and try it out in under 30 seconds with $5 of free credits.

Get started with Chroma Cloud

API

The core API is only 4 functions (run our 💡 Google Colab):

import chromadb
# setup Chroma in-memory, for easy prototyping. Can add persistence easily!
client = chromadb.Client()

# Create collection. get_collection, get_or_create_collection, delete_collection also available!
collection = client.create_collection("all-my-documents")

# Add docs to the collection. Can also update and delete. Row-based API coming soon!
collection.add(
    documents=["This is document1", "This is document2"], # we handle tokenization, embedding, and indexing automatically. You can skip that and add your own embeddings as well
    metadatas=[{"source": "notion"}, {"source": "google-docs"}], # filter on these!
    ids=["doc1", "doc2"], # unique for each doc
)

# Query/search 2 most similar results. You can also .get by id
results = collection.query(
    query_texts=["This is a query document"],
    n_results=2,
    # where={"metadata_field": "is_equal_to_this"}, # optional filter
    # where_document={"$contains":"search_string"}  # optional filter
)

Learn about all features on our Docs

Get involved

Chroma is a rapidly developing project. We welcome PR contributors and ideas for how to improve the project.

Release Cadence We currently release new tagged versions of the pypi and npm packages on Mondays. Hotfixes go out at any time during the week.

License

Apache 2.0

chroma (chroma-core/chroma)

Searching Database…

29.5K ·GitHub
Что это такое?Chroma — это инфраструктура данных с открытым исходным кодом для ИИ: векторная база данных, которая обеспечивает поиск по эмбеддингам. Применяется для таких задач, как генерация с дополнением из поиска (RAG) и память ИИ-агентов.
Это база данных или клиентская библиотека?Это движок базы данных (написан на Rust), который можно запустить самостоятельно или использовать в облаке. Доступ к нему осуществляется через клиентские пакеты, распространяемые через pypi и npm.
Как начать работу с Chroma?Самый простой путь — Chroma Cloud: создайте базу данных и начните её использовать меньше чем за 30 секунд, используя $5 бесплатных кредитов. Также поддерживается самостоятельное развёртывание через пакеты pypi/npm и Docker.
Что нужно для использования клиента Chroma?Нужен либо клиентский пакет для Python (pypi), либо для JavaScript/TypeScript (npm), чтобы обращаться к экземпляру Chroma, либо аккаунт Chroma Cloud для облачного варианта.
Сложно ли освоить основной API?Нет — основной API намеренно минималистичен и включает всего 4 функции, поэтому порог вхождения низкий, хотя это полноценная база данных.
Какие виды поиска поддерживает Chroma?Chroma Cloud обеспечивает бессерверный векторный, гибридный и полнотекстовый поиск, так что можно сочетать семантический поиск (на основе эмбеддингов) с традиционным поиском по ключевым словам.
Что именно представляет собой Chroma Cloud?Это облачный сервис Chroma — управляемая бессерверная версия базы данных, которая быстрая, экономичная и масштабируемая, так что не нужно самостоятельно разворачивать инфраструктуру.
Как часто Chroma выпускает обновления?Команда выпускает новые помеченные версии пакетов pypi и npm каждый понедельник, а срочные исправления выходят в любой день недели по мере необходимости.
Зачем использовать Chroma вместо обычной базы данных?Chroma создана специально для задач ИИ-поиска, таких как эмбеддинги и RAG, и сразу предоставляет векторный, гибридный и полнотекстовый поиск через компактный API из 4 функций.
What are similar projects?txtai, weaviate, m_flow, memvid, orama, xerj, localGPT, PageIndex
Size
855.9 MB
Stars
29.5K
Age
4y
Commits · 90 Days