WaitThatShouldntWork / InferGPT

Your local personalised AI agent

InferGPT: your local personalised AI agent

InferGPT's mission is to be an AI that knows you better than your best friend. A system that personalises to who you are and what you care about. We want to build something that can:

🔗 Ingest data about you from various sources (with your permission of course)
💡 Have deep and personal conversations without having to answer lots of questions - it will already infer your needs, make personalised recommendations and remember all your conversations.
🎯 Help you set and keep track of goals.
🏗️ Carry out tasks: this is an agent after all - it will go away and action stuff for you!
🔮 Predict what you need before you need it!

We aim to be able to answer complex questions that require a deep understanding of someone to effectively answer, such as:

1. How can i be better with my finances?
2. I'm trying to lose weight but its not working, why?
3. I'm learning to code, can you create a tailored learning plan?

Roadmap & Docs

Want more context about how it works, our roadmap and documentation? Check out the wiki

For further reading on InferGPT's components, see any of the following

• Full system testing
• Data persistence
• Backend
• Frontend
• Assets
• Testing
• Financial Bot

Contribute

See the contribution guide for further guidance. Note this guide is in progress!

Getting Started

In the top-right corner of the page, click Fork.

On the next page, select your GitHub account to create the fork under. Wait for the forking process to complete. You now have a copy of the repository in your GitHub account.

Clone the Repository

To clone the repository, you need to have Git installed on your system. Use the official Git installer or follow the terminal commands guide.

Once you have Git installed, follow these steps:

• Open your terminal.
• Navigate to the directory where you want to clone the repository.
• Run the git clone command for the fork you just created.

Install Neo4j Desktop or Aura DB

Instructions can be found here.
Install the pre-made recommendations database. Version 4.4 is the latest stable.

Running the service

• Create .env files based on the .env.example files under /frontend and /backend

Using Docker

• Start and open the Neo4J Desktop app. Start the default database (neo4j).
• create .env files as instructed within the frontend README and backend README
• Run the Docker Desktop app (install it from docker.com if you don't have it)
• In the root directory of the project run docker compose up
  • Note the first time you do this it may take longer as the compose file builds the images

Using pip and python

• Open your preferred terminal. It's recommended (though not technically required) to create a virtual environment for the project by running python -m venv .venv to create it and .venv/Scripts/activate to activate it in your active terminal.
• Follow the frontend README to set up the front end
• Follow the backend README to set up the back end
• Once all dependencies have been pulled run uvicorn app:api to start the app. Check the backend app is running at http://127.0.0.1:8000/health.

Usage

Coming

LICENCE

See LICENCE.md