diff --git a/README.md b/README.md index b165236..768266c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # antimat_neuro -Антимат 2.0 с ИИ. \ No newline at end of file +Антимат 2.0 с ИИ. + +# Документация +### Содержание +1. Изменение базы данных +2. Тренировка модели +3. Запуск модели + + +## 1. Изменение базы данных +Вся база с словами находится в db.json +Ключ 0 - обычные слова, ключ 1 - матерные слова. + +Для добавления через Ctrl+V: +1. Запустить `python txt_export.py` +2. Выбрать режим(0/1): не мат/мат. +3. Написать `exit` для завершения + +Для графического изменения: +1. Запустить `python json_edit.py` +2. Редактировать с помощью комбинаций клавиш: +- Ctrl+a - снять выделение +- Ctrl+s - поиск по фрагменту слова +- Delete - удаление выделенного слова +- Enter - добавления слова в поле + +## 2. Тренировка модели +1. Запустить `python train.py` +2. Ждать + +## 3. Запуск модели +1. Запустить `python run.py` +2. Ввести какое-то слово +3. Ввести `exit` для выхода \ No newline at end of file