badalsahani commited on
Commit
c366e43
Β·
verified Β·
1 Parent(s): 287a0bc

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -106
README.md DELETED
@@ -1,106 +0,0 @@
1
- <p align="center">
2
- <a href="https://trychroma.com"><img src="https://user-images.githubusercontent.com/891664/227103090-6624bf7d-9524-4e05-9d2c-c28d5d451481.png" alt="Chroma logo"></a>
3
- </p>
4
-
5
- <p align="center">
6
- <b>Chroma - the open-source embedding database</b>. <br />
7
- The fastest way to build Python or JavaScript LLM apps with memory!
8
- </p>
9
-
10
- <p align="center">
11
- <a href="https://discord.gg/MMeYNTmh3x" target="_blank">
12
- <img src="https://img.shields.io/discord/1073293645303795742" alt="Discord">
13
- </a> |
14
- <a href="https://github.com/chroma-core/chroma/blob/master/LICENSE" target="_blank">
15
- <img src="https://img.shields.io/static/v1?label=license&message=Apache 2.0&color=white" alt="License">
16
- </a> |
17
- <a href="https://docs.trychroma.com/" target="_blank">
18
- Docs
19
- </a> |
20
- <a href="https://www.trychroma.com/" target="_blank">
21
- Homepage
22
- </a>
23
- </p>
24
-
25
-
26
- <p align="center">
27
- <a href="https://github.com/chroma-core/chroma/actions/workflows/chroma-integration-test.yml" target="_blank">
28
- <img src="https://github.com/chroma-core/chroma/actions/workflows/chroma-integration-test.yml/badge.svg?branch=main" alt="Integration Tests">
29
- </a> |
30
- <a href="https://github.com/chroma-core/chroma/actions/workflows/chroma-test.yml" target="_blank">
31
- <img src="https://github.com/chroma-core/chroma/actions/workflows/chroma-test.yml/badge.svg?branch=main" alt="Tests">
32
- </a>
33
- </p>
34
-
35
- ```bash
36
- pip install chromadb # python client
37
- # for javascript, npm install chromadb!
38
- # for client-server mode, chroma run --path /chroma_db_path
39
- ```
40
-
41
- The core API is only 4 functions (run our [πŸ’‘ Google Colab](https://colab.research.google.com/drive/1QEzFyqnoFxq7LUGyP1vzR4iLt9PpCDXv?usp=sharing) or [Replit template](https://replit.com/@swyx/BasicChromaStarter?v=1)):
42
-
43
- ```python
44
- import chromadb
45
- # setup Chroma in-memory, for easy prototyping. Can add persistence easily!
46
- client = chromadb.Client()
47
-
48
- # Create collection. get_collection, get_or_create_collection, delete_collection also available!
49
- collection = client.create_collection("all-my-documents")
50
-
51
- # Add docs to the collection. Can also update and delete. Row-based API coming soon!
52
- collection.add(
53
- 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
54
- metadatas=[{"source": "notion"}, {"source": "google-docs"}], # filter on these!
55
- ids=["doc1", "doc2"], # unique for each doc
56
- )
57
-
58
- # Query/search 2 most similar results. You can also .get by id
59
- results = collection.query(
60
- query_texts=["This is a query document"],
61
- n_results=2,
62
- # where={"metadata_field": "is_equal_to_this"}, # optional filter
63
- # where_document={"$contains":"search_string"} # optional filter
64
- )
65
- ```
66
-
67
- ## Features
68
- - __Simple__: Fully-typed, fully-tested, fully-documented == happiness
69
- - __Integrations__: [`πŸ¦œοΈπŸ”— LangChain`](https://blog.langchain.dev/langchain-chroma/) (python and js), [`πŸ¦™ LlamaIndex`](https://twitter.com/atroyn/status/1628557389762007040) and more soon
70
- - __Dev, Test, Prod__: the same API that runs in your python notebook, scales to your cluster
71
- - __Feature-rich__: Queries, filtering, density estimation and more
72
- - __Free & Open Source__: Apache 2.0 Licensed
73
-
74
- ## Use case: ChatGPT for ______
75
-
76
- For example, the `"Chat your data"` use case:
77
- 1. Add documents to your database. You can pass in your own embeddings, embedding function, or let Chroma embed them for you.
78
- 2. Query relevant documents with natural language.
79
- 3. Compose documents into the context window of an LLM like `GPT3` for additional summarization or analysis.
80
-
81
- ## Embeddings?
82
-
83
- What are embeddings?
84
-
85
- - [Read the guide from OpenAI](https://platform.openai.com/docs/guides/embeddings/what-are-embeddings)
86
- - __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.
87
- - __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.
88
- - __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.
89
- - __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.
90
-
91
- 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](https://docs.trychroma.com/embeddings#sentence-transformers) to embed for you but you can also use OpenAI embeddings, Cohere (multilingual) embeddings, or your own.
92
-
93
- ## Get involved
94
-
95
- Chroma is a rapidly developing project. We welcome PR contributors and ideas for how to improve the project.
96
- - [Join the conversation on Discord](https://discord.gg/MMeYNTmh3x) - `#contributing` channel
97
- - [Review the πŸ›£οΈ Roadmap and contribute your ideas](https://docs.trychroma.com/roadmap)
98
- - [Grab an issue and open a PR](https://github.com/chroma-core/chroma/issues) - [`Good first issue tag`](https://github.com/chroma-core/chroma/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
99
- - [Read our contributing guide](https://docs.trychroma.com/contributing)
100
-
101
- **Release Cadence**
102
- We currently release new tagged versions of the `pypi` and `npm` packages on Mondays. Hotfixes go out at any time during the week.
103
-
104
- ## License
105
-
106
- [Apache 2.0](./LICENSE)