Skip to content

Latest commit

 

History

History
171 lines (125 loc) · 6 KB

README.md

File metadata and controls

171 lines (125 loc) · 6 KB

Contributors Forks Stargazers Issues Pull Request MIT License


Logo

Khumon Education LLM Engine

API Engine for KHUMON Education service using LLM.
Explore the API docs »



Report Issues · Pull Requests

🗃️ Built With

💡 Language

Python

💡 Frameworks

Fastapi

(back to top)

🚀 Getting Started

⚡ Prerequisites

🚀 Guideline

I recommend building your environment on top of a virtual environment (e.g., venv, anaconda, etc.)

  • Setup

    make setup
  • Run application

    uvicorn app.main:app
  • Linting & Testing

    # Linting
    make style
    
    # Testing
    make test
  • Dockerizing

    docker build -t nickname/imagename .

(back to top)

🌐 Features

  • Summarize and quiz lecture notes or videos.
  • You can input text, PDF, or video.
  • For more information, please refer to the API documentation.

(back to top)

🔥 Contributing

Please refer to CONTRIBUTING.md for Contribution.

For issues, new functions and requests to modify please follow the following procedure. 🥰

  1. Fork the Project
  2. Create a Issue when you have new feature or bug, just not Typo fix
  3. Create your Feature Branch from dev Branch (git checkout -b feat/Newfeature)
  4. Commit your Changes (git commit -m 'feat: add new feature')
  5. Push to the Branch (git push origin feat/Newfeature)
  6. Open a Pull Request to dev branch with Issues

(back to top)

🔐 License

Please refer to LICENSE for LICENSE.

(back to top)

💬 Contact


Yongwoo Song

(back to top)