Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.1%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: Trawmoney
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 227 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created almost 3 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License Citation

README.md

Chroma logo

Chroma - the open-source embedding database.
The fastest way to build Python or JavaScript LLM apps with memory!

Discord | License | Docs | Homepage

```bash pip install chromadb # python client

for javascript, npm install chromadb!

for client-server mode, docker-compose up -d --build

```

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

```python import chromadb

setup Chroma in-memory, for easy prototyping. Can add persistence easily!

client = chromadb.Client()

Create collection. getcollection, getorcreatecollection, 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( querytexts=["This is a query document"], nresults=2, # where={"metadatafield": "isequaltothis"}, # optional filter # wheredocument={"$contains":"searchstring"} # optional filter ) ```

Features

  • Simple: Fully-typed, fully-tested, fully-documented == happiness
  • Integrations: 🦜️🔗 LangChain (python and js), 🦙 LlamaIndex and more soon
  • Dev, Test, Prod: the same API that runs in your python notebook, scales to your cluster
  • Feature-rich: Queries, filtering, density estimation and more
  • Free & Open Source: Apache 2.0 Licensed

Use case: ChatGPT for ______

For example, the "Chat your data" use case: 1. Add documents to your database. You can pass in your own embeddings, embedding function, or let Chroma embed them for you. 2. Query relevant documents with natural language. 3. Compose documents into the context window of an LLM like GPT3 for additional summarization or analysis.

Embeddings?

What are embeddings?

  • Read the guide from OpenAI
  • Literal: Embedding something turns it from image/text/audio into a list of numbers. 🖼️ or 📄 => [1.2, 2.1, ....]. This process makes documents "understandable" to a machine learning model.
  • By analogy: An embedding represents the essence of a document. This enables documents and queries with the same essence to be "near" each other and therefore easy to find.
  • Technical: An embedding is the latent-space position of a document at a layer of a deep neural network. For models trained specifically to embed data, this is the last layer.
  • A small example: If you search your photos for "famous bridge in San Francisco". By embedding this query and comparing it to the embeddings of your photos and their metadata - it should return photos of the Golden Gate Bridge.

Embeddings databases (also known as vector databases) store embeddings and allow you to search by nearest neighbors rather than by substrings like a traditional database. By default, Chroma uses Sentence Transformers to embed for you but you can also use OpenAI embeddings, Cohere (multilingual) embeddings, or your own.

Get involved

Chroma is a rapidly developing project. We welcome PR contributors and ideas for how to improve the project. - Join the conversation on Discord - Review the roadmap and contribute your ideas - Grab an issue and open a PR

License

Apache 2.0

Owner

  • Name: Neuromancer
  • Login: Trawmoney
  • Kind: user
  • Location: Michigan
  • Company: @SewerLabs

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Chase"
  given-names: "Harrison"
title: "LangChain"
date-released: 2022-10-17
url: "https://github.com/hwchase17/langchain"

GitHub Events

Total
Last Year

Dependencies

Dockerfile docker
  • python 3.10 build
docker-compose.test.yml docker
  • clickhouse/clickhouse-server 22.9-alpine
docker-compose.yml docker
  • clickhouse/clickhouse-server 22.9-alpine
poetry.lock pypi
  • 401 dependencies
pyproject.toml pypi
  • clickhouse_connect >= 0.5.7
  • duckdb >= 0.7.1
  • fastapi >= 0.85.1
  • hnswlib >= 0.7
  • numpy >= 1.21.6
  • pandas >= 1.3
  • posthog >= 2.4.0
  • pydantic >= 1.9
  • requests >= 2.28
  • sentence-transformers >= 2.2.2
  • typing_extensions >= 4.5.0
  • uvicorn [standard] >= 0.18.3
requirements.txt pypi
  • clickhouse-connect ==0.5.7
  • duckdb ==0.7.1
  • fastapi ==0.85.1
  • hnswlib ==0.7.0
  • pandas ==1.3.5
  • posthog ==2.4.0
  • pydantic ==1.9.0
  • requests ==2.28.1
  • sentence-transformers ==2.2.2
  • typing_extensions ==4.5.0
  • uvicorn ==0.18.3
requirements_dev.txt pypi
  • black ==23.3.0 development
  • build * development
  • httpx * development
  • hypothesis * development
  • pytest * development
  • setuptools_scm * development