Git Product home page Git Product logo

colearner's Introduction

CoLearner

CoLearner is an intelligent assistant that converses with your personal knowledge base, including books, websites, notes, codes, etc. It's designed to provide information search and learning assistance for continuous learning throughout your career.

Built with Langchain using pretrained LLM and RAG pipeline. App is built with Streamlit and served on GCP.

Features

Feature Description
All in one place All information about what you have learned and worked on in once place
Personal Knowledge Chat Engage in conversations with an AI that understands your learning and work history
Information Retrieval Quickly find relevant information from your personal knowledge base
Learning Assistant Automatically make a review and recap plan based on recent learning
Progress Tracking Monitor your learning journey across various subjects and skills

Getting Started

Development Plan

Feature Description Progress
Project initialization Set up project structure and dev environment 🟢 Completed
Data Ingestion Develop system to import data from various sources:
   - Website
   - Notion
   - Git repository
     - Github
   - Youtube
   - Local files
🟡 In Progress
First prototype Implement a basic chatbot with RAG 🟢 Completed
RAG refinement Improve RAG pipeline performance:
   - Splitter
   - Embedding
   - Retrieval method
🔴 Not Started
Routing Design routing 🔴 Not Started
Agents Develope agents needed to create study plan and track progress 🔴 Not Started
Web App Develop a web app with Streamlit 🟢 Completed
Deployment Hosted on GCP 🟡 In Progress
Local deployment Instructions on local deployment 🔴 Not Started

Configure

Create a .env file from the environment template file env.example

Available variables:

Variable Name Default value Description
OLLAMA_BASE_URL http://host.docker.internal:11434 REQUIRED - URL to Ollama LLM API
LLM llama2 REQUIRED - Can be any Ollama model tag, or gpt-4 or gpt-3.5
EMBEDDING_MODEL sentence_transformer REQUIRED - Can be sentence_transformer, openai, aws, ollama or google-genai-embedding-001
OPENAI_API_KEY REQUIRED - Only if LLM=gpt-4 or LLM=gpt-3.5 or embedding_model=openai
LANGCHAIN_ENDPOINT https://api.smith.langchain.com OPTIONAL - URL to Langchain Smith API
LANGCHAIN_TRACING_V2 false OPTIONAL - Enable Langchain tracing v2
LANGCHAIN_PROJECT OPTIONAL - Langchain project name
LANGCHAIN_API_KEY OPTIONAL - Langchain API key

Contributing

We welcome contributions to MindWhisperer!

License

This project is licensed under the MIT License.

colearner's People

Contributors

sironghuang avatar

Stargazers

 avatar

Watchers

Lucian avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.