educhain 0.1.7

A Python package for generating educational content using Generative AI

educhain

A Python package for generating educational content using Generative AI. Educhain makes it easy to apply Generative AI in various educational use cases to create engaging and personalized learning experiences

Installation

pip install educhain

Usage

Use it to Generate MCQs

Here's an example of how to use EduChain:

Generate a multiple-choice question with given number of questions

from educhain import generate_mcq, to_csv, to_json, to_pdf

generate_mcq function

The generate_mcq function takes the following arguments:

• topic (str): The topic for which you want to generate MCQs.
• level (str): The difficulty level of the MCQs (e.g., "Beginner", "Intermediate", "Advanced").
• num (int, optional): The number of MCQs to generate. Defaults to 1.
• llm (LLM, optional): An instance of a language model from the langchain library. If not provided, the function will use the ChatOpenAI model with the "gpt-3.5-turbo-0125" version.
• topic (str): The topic for which you want to generate MCQs.
• level (str): The difficulty level of the MCQs (e.g., "Beginner", "Intermediate", "Advanced").
• num (int, optional): The number of MCQs to generate. Defaults to 1.
• llm (LLM, optional): An instance of a language model from the langchain library. If not provided, the function will use the ChatOpenAI model with the "gpt-3.5-turbo-0125" version.

The function returns an instance of the MCQList class, which is a custom class defined in the library. It contains a list of Question objects, each representing a single MCQ.

mcq = generate_mcq(topic="Python", level="Advanced", num=5)
print(mcq)

Save the MCQ to a CSV file

Save the MCQ to a CSV file

to_csv(mcq, "mcq.csv")

Save the MCQ to a JSON file

to_json(mcq, "mcq.json")

Save the MCQ to a PDF file

• heading (str): (optional)
• subheading (str): (optional)

to_pdf(mcq, "mcq.pdf", heading="Python MCQ", subheading="Advanced Level - (10 Questions)")

Effortlessly create Lesson Plans

from educhain import content_engine

topic = "Medieval History"
level = "Beginner"

lesson_plan = content_engine.generate_lesson_plan(topic, level)
print(lesson_plan)

Contributing

Contributions are welcome! Please open an issue or submit a pull request on the GitHub repository.

Next Steps

Will be releasing more features for MCQ Generation

• Bulk Generation
• Outputs in JSON format
• Export questions to CSV
• Exports questions to JSON
• Exports questions to PDF
• Support for other LLM models
• Generate questions from text/pdf file
• Finetuned Model for question generation