docs(readme): link the project report notebook and fix its location in the repo tree
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:
@@ -129,9 +129,9 @@ hamori/
|
||||
│ └── external_converters/ конвертеры публичных корпусов
|
||||
├── scripts/ CLI-обёртки над модулями src
|
||||
├── tests/ модульные тесты и фикстуры
|
||||
├── notebooks/ Jupyter-ноутбуки для исследования и отчётности
|
||||
├── notebooks/ Jupyter-ноутбуки: исследование данных и итоговый отчёт (report.ipynb)
|
||||
├── checkpoints/ сохранённые состояния моделей
|
||||
└── reports/ графики, примеры и итоговый отчёт
|
||||
└── reports/ сгенерированные графики и примеры
|
||||
```
|
||||
|
||||
## 5. Быстрый старт
|
||||
@@ -343,15 +343,20 @@ python scripts/evaluate.py \
|
||||
Подробное описание метрик и методологии оценки — в разделе 6 файла
|
||||
[docs/architecture.md](docs/architecture.md).
|
||||
|
||||
Готовые результаты — численные метрики, графики распределений и качественный
|
||||
разбор примеров — собраны в итоговом отчёте
|
||||
[notebooks/report.ipynb](notebooks/report.ipynb).
|
||||
|
||||
## 9. Дополнительная документация
|
||||
|
||||
| Документ | Назначение |
|
||||
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| [docs/chord_format_spec.md](docs/chord_format_spec.md) | Полная спецификация формата `.chord`, словарь токенов, правила парсинга. Авторитетный источник по формату. |
|
||||
| [docs/requirements.md](docs/requirements.md) | Функциональные и нефункциональные требования, критерии приёмки. |
|
||||
| [docs/architecture.md](docs/architecture.md) | Архитектура системы, схемы потоков данных, описания модулей, обоснование ключевых проектных решений. |
|
||||
| [docs/glossary.md](docs/glossary.md) | Глоссарий музыкальных, машинно-обучательных и проектных терминов. |
|
||||
| [CLAUDE.md](CLAUDE.md) | Постоянный контекст для Claude Code (на английском). Описывает правила разработки, чего нельзя делать без согласования и какие модули за что отвечают. |
|
||||
| Документ | Назначение |
|
||||
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [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) | Архитектура системы, схемы потоков данных, описания модулей, обоснование ключевых проектных решений. |
|
||||
| [docs/glossary.md](docs/glossary.md) | Глоссарий музыкальных, машинно-обучательных и проектных терминов. |
|
||||
| [CLAUDE.md](CLAUDE.md) | Постоянный контекст для Claude Code (на английском). Описывает правила разработки, чего нельзя делать без согласования и какие модули за что отвечают. |
|
||||
|
||||
## 10. Ограничения текущей версии
|
||||
|
||||
|
||||
Reference in New Issue
Block a user