Skip to content

The purpose of the study is to automate the analysis of scientific and educational documents in the context of research works using LLM

License

Notifications You must be signed in to change notification settings

aimclub/Edulytica

Repository files navigation

ITMO license Visitors codecov build docs

Built with:

python Jupyter Notebook FastAPI Docker GitHub Actions

Edulytica

logo

Description

Edulytica is an open-source framework for evaluating text results of educational and scientific activities based on LLMs, which provides an integrated web application out of the box.

The goal is to provide experts with supporting materials in solving the tasks of reviewing final qualifying papers and articles by young scientists, as well as to reduce the time required for in-depth analysis of works.

Features

  • The extraction of goals and objectives from the text of the introduction of final qualifying papers has been implemented;
  • As part of the work with scientific articles, the functionality of forming a primary review has been implemented;
  • Algorithms for summarizing large texts and evaluating the achievement of stated goals and objectives;
  • A web application for interacting with features and trained models through a user-friendly interface;
  • Separate models have been trained to summarize and assess the achievability of goals and objectives;
  • Datasets have been prepared for training models, separately for summarization, separately for goals and objectives.

Please help us improve this project, share your feedback with opening issue!

Installation

1. Clone the repository

git clone https://github.com/aimclub/Edulytica.git

2. Launch docker containers or follow the instructions starting from point 3

docker-compose up --build

3. Activate venv

source ~/PyProject/Edulytica/api_venv/bin/activate

4. Install requirements

pip install -r requirements.txt

5. Start Application

python3 src/edulytica_api/app.py

6. Activate Celery

celery -A src.edulytica_api.celery.tasks worker --loglevel=info -E -P gevent

7. Run npm

npm start

7. Run Celery task

celery -A src.edulytica_api.celery.tasks flower

Getting started

example

First, you can familiarize yourself with the examples in JSON format of the system's responses to the test sample of works.

When you have managed to launch the service, you can send the documents yourself and get acquainted with the results of their verification!

Documentation

Details of the documentation can be found at the links below:

  • algorithms - part of the task of analyzing the text how much it is necessary to change the source text (which is written by AI) so that AI recognition systems do not recognize AI in this text;
  • data_handling - an auxiliary module that stores parsers of data and documents for generating datasets;
  • edulytica_api - this module stores the source code of the web service;
  • extracting_rules - This module is devoted to an experiment with extracting design rules using LLM;
  • rag - Package for an experiment with semantic search, kNN and the mBERT model are used.

Code documentation is available at the link.

Requirements

For more information, see the file requiremets.txt.

Contacts

Our contacts:

Publications about Edulytica

We also published several posts devoted to different aspects of the project:

In Russian:

About

The purpose of the study is to automate the analysis of scientific and educational documents in the context of research works using LLM

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 14