Skip to content

Commit

Permalink
Merge branch 'main' into feat/COG-544-eval-on-swe-bench
Browse files Browse the repository at this point in the history
  • Loading branch information
Rita Aleksziev committed Nov 19, 2024
2 parents d07ebbe + c045f73 commit 9973aff
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 22 deletions.
4 changes: 2 additions & 2 deletions .env.template
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ GRAPHISTRY_PASSWORD=
SENTRY_REPORTING_URL=

# "neo4j" or "networkx"
GRAPH_DATABASE_PROVIDER="neo4j"
GRAPH_DATABASE_PROVIDER="networkx"
# Not needed if using networkx
GRAPH_DATABASE_URL=
GRAPH_DATABASE_USERNAME=
GRAPH_DATABASE_PASSWORD=

# "qdrant", "pgvector", "weaviate" or "lancedb"
VECTOR_DB_PROVIDER="qdrant"
VECTOR_DB_PROVIDER="lancedb"
# Not needed if using "lancedb" or "pgvector"
VECTOR_DB_URL=
VECTOR_DB_KEY=
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test_cognee_llama_index_notebook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:

- name: Install dependencies
run: |
poetry install --no-interaction --all-extras --no-root
poetry install --no-interaction --all-extras
poetry add jupyter --no-interaction
- name: Execute Jupyter Notebook
Expand Down
42 changes: 27 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,14 @@
We build for developers who need a reliable, production-ready data layer for AI applications


## What is cognee?
## What is cognee?

Cognee implements scalable, modular ECL (Extract, Cognify, Load) pipelines that allow you to interconnect and retrieve past conversations, documents, and audio transcriptions while reducing hallucinations, developer effort, and cost.
Try it in a Google Colab <a href="https://colab.research.google.com/drive/1g-Qnx6l_ecHZi0IOw23rg0qC4TYvEvWZ?usp=sharing">notebook</a> or have a look at our <a href="https://topoteretes.github.io/cognee">documentation</a>

If you have questions, join our <a href="https://discord.gg/NQPKmU5CCg">Discord</a> community





## 📦 Installation

### With pip
Expand All @@ -47,6 +44,7 @@ poetry add cognee
poetry add cognee -E postgres
```


## 💻 Basic Usage

### Setup
Expand Down Expand Up @@ -83,7 +81,7 @@ docker-compose up
```
Then navigate to localhost:3000

If you want to use the UI with PostgreSQL through docker-compose make sure to set the following values in the .env file:
If you want to use Cognee with PostgreSQL, make sure to set the following values in the .env file:
```
DB_PROVIDER=postgres
Expand All @@ -97,9 +95,7 @@ DB_PASSWORD=cognee

### Simple example

First, copy `.env.template` to `.env` and add your OpenAI API key to the LLM_API_KEY field.

Optionally, set `VECTOR_DB_PROVIDER="lancedb"` in `.env` to simplify setup.
First, copy `.env.template` to `.env` and add your OpenAI API key to the LLM_API_KEY field.

This script will run the default pipeline:

Expand Down Expand Up @@ -140,7 +136,7 @@ async def main():

asyncio.run(main())
```
A version of this example is here: `examples/pyton/simple_example.py`
A version of this example is here: `examples/python/simple_example.py`

### Create your own memory store

Expand Down Expand Up @@ -251,7 +247,6 @@ Cognee supports a variety of tools and services for different operations:
Check out our demo notebook [here](https://github.com/topoteretes/cognee/blob/main/notebooks/cognee_demo.ipynb)



[<img src="https://i3.ytimg.com/vi/-ARUfIzhzC4/maxresdefault.jpg" width="100%">](https://www.youtube.com/watch?v=BDFt4xVPmro "Learn about cognee: 55")


Expand All @@ -274,15 +269,32 @@ Please see the cognee [Development Guide](https://topoteretes.github.io/cognee/q
pip install cognee
```

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=topoteretes/cognee&type=Date)](https://star-history.com/#topoteretes/cognee&Date)


## 💫 Contributors

<a href="https://github.com/topoteretes/cognee/graphs/contributors">
<img alt="contributors" src="https://contrib.rocks/image?repo=topoteretes/cognee"/>
</a>


## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=topoteretes/cognee&type=Date)](https://star-history.com/#topoteretes/cognee&Date)


## Vector & Graph Databases Implementation State

<style>
table {
width: 100%;
}
</style>

| Name | Type | Current state | Known Issues |
|------------------|--------------------|-------------------|---------------------------------------|
| Qdrant | Vector | Stable &#x2705; | |
| Weaviate | Vector | Stable &#x2705; | |
| LanceDB | Vector | Stable &#x2705; | |
| Neo4j | Graph | Stable &#x2705; | |
| NetworkX | Graph | Stable &#x2705; | |
| FalkorDB | Vector/Graph | Unstable &#x274C; | |
| PGVector | Vector | Unstable &#x274C; | Postgres DB returns the Timeout error |
4 changes: 2 additions & 2 deletions cognee-frontend/src/ui/Partials/SettingsModal/Settings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ const defaultProvider = {
};

const defaultModel = {
label: 'gpt-4o',
value: 'gpt-4o',
label: 'gpt-4o-mini',
value: 'gpt-4o-mini',
};

export default function Settings({ onDone = () => {}, submitButtonText = 'Save' }) {
Expand Down
2 changes: 1 addition & 1 deletion cognee/infrastructure/llm/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

class LLMConfig(BaseSettings):
llm_provider: str = "openai"
llm_model: str = "gpt-4o"
llm_model: str = "gpt-4o-mini"
llm_endpoint: str = ""
llm_api_key: Optional[str] = None
llm_temperature: float = 0.0
Expand Down
3 changes: 3 additions & 0 deletions cognee/modules/settings/get_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@ def get_settings() -> SettingsDict:
"providers": llm_providers,
"models": {
"openai": [{
"value": "gpt-4o-mini",
"label": "gpt-4o-mini",
}, {
"value": "gpt-4o",
"label": "gpt-4o",
}, {
Expand Down
1 change: 0 additions & 1 deletion examples/python/simple_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
# 1. Copy `.env.template` and rename it to `.env`.
# 2. Add your OpenAI API key to the `.env` file in the `LLM_API_KEY` field:
# LLM_API_KEY = "your_key_here"
# 3. (Optional) To minimize setup effort, set `VECTOR_DB_PROVIDER="lancedb"` in `.env".

async def main():
# Create a clean slate for cognee -- reset data and system state
Expand Down

0 comments on commit 9973aff

Please sign in to comment.