Skip to content

Fine-tuned bart_based transformer that converts your Python functions to doctring

Notifications You must be signed in to change notification settings

EgorZhuchkov/code_to_docstring

Repository files navigation

Генерация комментариев к методам

Участники проекта:

  • Жучков Е.А. ИДБ-18-09
  • Жучкова Т.Г. ИДБ-18-09

Краткое описание проекта

Приложение получает от пользователя метод или функцию на одном из поддерживаемых языков программирования. Обученная модель генерирует комментарий на основе данного кода, описывающий его функционал.

Детали реализации

Поскольку данная проблема сводится к задаче машинного перевода, была выбрана seq2seq архитектура на основе трансформера BART. Для обучения были взяты данные из датасета CodeSearchNet. На данный момент для генерации доступны только функции на языке Python. Приложение использует Flask в качестве веб-фреймворка.

Инструкция по запуску на локальном компьютере

  1. Клонировать проект на локальный компьютер.
git clone https://github.com/EgorZhuchkov/code_to_docstring
cd code_to_docstring
  1. Убедиться, что на компьютере установлены необходимые зависимости, указанные в requirements.txt.
pip install -r requirements.txt
  1. Запустить файл app.py в корне проекта.
python app.py
  1. Перейти по адресу указанному в консоли. Например:
Running on http:https://localhost:5000/

Предупреждение:
При запуске приложение загружает из облака модель и чекпоинт. Это может занять некоторое время.

About

Fine-tuned bart_based transformer that converts your Python functions to doctring

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages