A.R.T.H.U.R.

A.R.T.H.U.R. - Academic Research Tool for Helpful Understanding and Retrieval.

Содержание

• Описание
• Установка
• Использование
  • Запуск приложения
  • Основные вкладки
• Структура проекта
• Примеры использования

Описание

A.R.T.H.U.R. - это инструмент для академических исследований, который помогает загружать, обрабатывать и анализировать научные статьи. Он предоставляет удобный интерфейс для работы с PDF-файлами, генерации аннотаций и обзоров литературы, а также создания статей на основе заданных тем.

Установка

1. Клонируйте репозиторий:

   git clone https://github.com/LISA-ITMO/ai-assistant.git
   cd ai-assistant

2. Создайте и активируйте виртуальное окружение:

   python -m venv venv
   source venv/bin/activate

3. Установите зависимости:

   pip install -r requirements.txt

4. Установите переменные окружения:

   export OPENAI_API_KEY=<your_openai_api_key>

Использование

Запуск приложения

1. Установите переменную окружения PYTHONPATH:

   export PYTHONPATH=$(pwd)

2. Запустите приложение Streamlit:

   streamlit run src/app.py

Основные вкладки

• Upload: Загрузка PDF-файлов научных статей.
• Materials: Просмотр загруженных статей, генерация аннотаций и обзоров литературы.
• Generate: Генерация статей на основе заданной темы.
• Settings: Настройки длины статьи, стиля написания и языка.

Структура проекта

ai-assistant/
├── src/
│   ├── app.py
│   ├── modules/
│   │   ├── agents.py
│   │   ├── rag.py
│   │   └── vector_database.py
│   └── utils/
│       └── file_io.py
├── uploaded_files/
├── venv/
├── requirements.txt
└── README.md

Примеры использования

Загрузка и просмотр статей

1. Перейдите на вкладку Upload и загрузите PDF-файл научной статьи.
2. Перейдите на вкладку Materials, чтобы просмотреть загруженную статью и сгенерировать аннотацию или обзор.

Генерация литературного обзора

1. Перейдите на вкладку Materials.
2. Выберите загруженную статью, для которой хотите сгенерировать обзор.
3. Нажмите кнопку Generate Review, чтобы получить обзор литературы по выбранной статье.

Генерация аннотаций

1. Перейдите на вкладку Materials.
2. Выберите загруженную статью, для которой хотите сгенерировать аннотацию.
3. Нажмите кнопку Generate Annotation, чтобы получить аннотацию по выбранной статье.