Giter VIP home page Giter VIP logo

educhain's Introduction

Educhain ๐ŸŽ“๐Ÿ”—

PyPI version License: MIT Python Versions Downloads

Website | Documentation |

Educhain is a powerful Python package that leverages Generative AI to create engaging and personalized educational content. From generating multiple-choice questions to crafting comprehensive lesson plans, Educhain makes it easy to apply AI in various educational scenarios.

Educhain Logo

๐Ÿš€ Features

  • ๐Ÿ“ Generate Multiple Choice Questions (MCQs)
  • ๐Ÿ“Š Create Lesson Plans
  • ๐Ÿ”„ Support for various LLM models
  • ๐Ÿ“ Export questions to JSON, PDF, and CSV formats
  • ๐ŸŽจ Customizable prompt templates
  • ๐Ÿ“š Generate questions from text/PDF files

๐Ÿ“ˆ Performance

Educhain consistently outperforms traditional methods in content generation speed and quality:

Performance Comparison Graph

๐Ÿ›  Installation

pip install educhain

๐ŸŽฎ Usage

Generate MCQs

Open In Colab

Quick Start

from educhain import qna_engine

questions = qna_engine.generate_mcq(
    topic="Indian History",
    level="Beginner",
    num=5
)
print(questions)

Using Custom Prompt Templates

from educhain import qna_engine

custom_template = """
Generate {num} multiple-choice question (MCQ) based on the given topic and level.
Provide the question, four answer options, and the correct answer.
Topic: {topic}
Learning Objective: {learning_objective}
Difficulty Level: {difficulty_level}
"""

result = qna_engine.generate_mcq(
    topic="Python Programming",
    num=2,
    learning_objective="Usage of Python classes",
    difficulty_level="Hard",
    prompt_template=custom_template,
)
print(result)

Using Different LLM Models

from educhain import qna_engine
from langchain_openai import ChatOpenAI

llama3_groq = ChatOpenAI(
    model="llama3-70b-8192",
    openai_api_base="https://api.groq.com/openai/v1",
    openai_api_key="GROQ_API_KEY"
)

questions = qna_engine.generate_mcq(
    topic="Chess",
    level="Hard",
    num=5,
    llm=llama3_groq
)
print(questions)

Generate Questions from Data Sources

from educhain import qna_engine

questions = qna_engine.generate_mcqs_from_data(
    source="https://example.com/article",
    source_type="url",
    num=5,
    learning_objective="Understand key concepts",
    difficulty_level="Intermediate"
)
print(questions)

Export Questions

from educhain import to_json, to_pdf, to_csv

to_json(questions, "questions.json")  # Export questions to JSON
to_pdf(questions, "questions.pdf")    # Export questions to PDF
to_csv(questions, "questions.csv")    # Export questions to CSV

Generate Lesson Plans

from educhain import content_engine

topic = "Medieval History"
level = "Beginner"
lesson_plan = content_engine.generate_lesson_plan(topic, level)
print(lesson_plan)

๐Ÿ“Š Supported Question Types

  • Multiple Choice Questions (MCQ)
  • Short Answer Questions
  • True/False Questions
  • Fill in the Blank Questions

๐Ÿ”ง Advanced Configuration

Educhain offers advanced configuration options to fine-tune its behavior. Check our configuration guide for more details.

๐ŸŒŸ Success Stories

Educators worldwide are using Educhain to transform their teaching. Read our case studies to learn more.

๐Ÿ“ˆ Usage Statistics

Educhain's adoption has been growing rapidly:

Usage Growth Graph

๐Ÿ—บ Roadmap

  • Bulk Generation
  • Outputs in JSON format
  • Custom Prompt Templates
  • Custom Response Models using Pydantic
  • Exports questions to JSON/PDF/CSV
  • Support for other LLM models
  • Generate questions from text/PDF file
  • Finetuned Model for question generation
  • Integration with popular Learning Management Systems
  • Mobile app for on-the-go content generation

๐Ÿค Contributing

We welcome contributions! Please see our Contribution Guide for more details.

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgements

  • OpenAI for their GPT models
  • Langchain for the ChatOpenAI interface
  • Our amazing community of contributors

๐Ÿ“ฌ Contact

For bug reports or feature requests, please open an issue on our GitHub repository.


Educhain Logo

Made with โค๏ธ by Buildfastwithai

www.educhain.in

educhain's People

Contributors

satvik314 avatar vedantdeshmukh2 avatar lunatic-7 avatar prathmeshsadake 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.