tech/hamori
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs(readme): link the project report notebook and fix its location in the repo tree

Browse Source 
The report lives in notebooks/report.ipynb, but section 4 listed the
final report under reports/. Point readers to it from sections 8 and 9
and correct the repo-tree description.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Masahiko AMANO
2026-06-04 23:24:33 +03:00
parent 7b68d86ce5
commit 5ab10de7ee
1 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -3
View File
@@ -129,9 +129,9 @@ hamori/
│ └── external_converters/ конвертеры публичных корпусов
├── scripts/ CLI-обёртки над модулями src
├── tests/ модульные тесты и фикстуры
├── notebooks/ Jupyter-ноутбуки для исследования и отчётности
├── notebooks/ Jupyter-ноутбуки: исследование данных и итоговый отчёт (report.ipynb)
├── checkpoints/ сохранённые состояния моделей
└── reports/ графики, примеры и итоговый отчёт
└── reports/ сгенерированные графики и примеры
```
## 5. Быстрый старт
@@ -343,10 +343,15 @@ python scripts/evaluate.py \
Подробное описание метрик и методологии оценки — в разделе 6 файла
[docs/architecture.md](docs/architecture.md).
Готовые результаты — численные метрики, графики распределений и качественный
разбор примеров — собраны в итоговом отчёте
[notebooks/report.ipynb](notebooks/report.ipynb).
## 9. Дополнительная документация
| Документ | Назначение |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [notebooks/report.ipynb](notebooks/report.ipynb) | Итоговый отчёт по проекту (Jupyter-ноутбук на русском): постановка задачи, формат данных, модель, обучение, оценка с графиками, хроника разработки и выводы. Запускается целиком. |
| [docs/chord_format_spec.md](docs/chord_format_spec.md) | Полная спецификация формата `.chord`, словарь токенов, правила парсинга. Авторитетный источник по формату. |
| [docs/requirements.md](docs/requirements.md) | Функциональные и нефункциональные требования, критерии приёмки. |
| [docs/architecture.md](docs/architecture.md) | Архитектура системы, схемы потоков данных, описания модулей, обоснование ключевых проектных решений. |