Giter Club home page Giter Club logo

teachgpt's Introduction

TeachGPT๐Ÿค–

TeachGPT is a groundbreaking open-source initiative focused on developing an AI-Powered Virtual Tutor. This innovative virtual tutor leverages the full potential of artificial intelligence to revolutionize the way we learn. The primary objective is to construct a Large Language Model(LLM) that dynamically adjusts to individual learning styles while delivering lifelike conversations through AI agents. This is complemented by seamless integration of speech recognition technology and the strategic incorporation of gamification methods ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป .

Installation ๐Ÿ› ๏ธ

To get started with TeachGPT, follow these steps:

  1. Clone the repository: git clone https://github.com/Priyamakeshwari/TeachGPT.git
  2. Navigate to the project directory: cd TeachGPT

Contributing ๐Ÿ‘ฅ

Contributions are welcome! please follow these steps:

  1. Fork the TeachGPT repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes: git checkout -b feature-name.
  4. Implement your changes and commit them with meaningful commit messages.
  5. Push your changes to your forked repository.
  6. Create a pull request (PR) to the main TeachGPT repository, describing your changes and the problem they solve.

Our team will review your PR, provide feedback, and merge it if it meets our guidelines.

If your changes include new functionality or modifications, please write appropriate unit tests to ensure that the code works as expected. Run the existing tests to ensure that your changes do not introduce regressions.

License ๐Ÿ“

TeachGPT is released under the MIT License. ๐Ÿ“„

teachgpt's People

Contributors

aelew avatar neokd avatar priyamakeshwari avatar rishabh-git10 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

teachgpt's Issues

Add TXT loader

Add TXT loader to load txt files from documents directory

Code Documentation

To add documentation for the entire code base for easy understanding and helping future contributors to understand the code easily.
The documentation should be in the formatted.

Below is the example for documenting a function.

def add(a, b):
    """
    Adds two numbers and returns the result.
    
    Args:
        a (int): The first number.
        b (int): The second number.
    
    Returns:
        int: The sum of `a` and `b`.
    """
    return a + b

Arg Parser

Make an arg parser to parse parameters like DEVICE_TYPE and model_type in builder.py and main.py allowing users to pass in terminal itself

enhance readme?

Is your feature request related to a problem? Please describe.
enhance readme by explaing what project do in a good manner

Describe the solution you'd like
adding contribution and code of conduct files

Additional context
Add any other context or screenshots about the feature request here.

Extend FAISS Support

Add FAISS support to store and make a retrieval QA system . Allowing users to choose their respective database

How to work with the program?

Describe the bug
I am unable to run a machine learning model after installing dependencies and running the program.
To Reproduce
Install dependencies using pip: pip install -r requirements.txt
Run the program: python main.py
Wait for the program to finish running, but nothing happens and there is only silence.
Expected behavior
I expected the program to start running the machine learning model and produce output.
Screenshots
N/A
Additional context
I have also downloaded additional programs and Mistral, but nothing seems to be working.
Add any other context about the problem here.

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.