docs/README.md

Documentation Index

This directory contains all project documentation.

📚 Main Guides

Getting Started

• HOW_TO_RUN.md - Complete guide to running the fine-tuning pipeline
• QUICK_START.md - Quick start guide for the project
• QUICK_START_API.md - API quick start guide

Fine-Tuning

• finetune/ - Fine-tuning documentation and guides
  • Data preparation
  • Dataset generation
  • Model training
  • Evaluation

RAG System

• README_RAG.md - RAG system overview
• guides/QUICK_START_RAG.md - RAG quick start
• guides/RAG_SETUP_COMPLETE.md - Complete RAG setup guide
• api/RAG_API.md - RAG API documentation

Deployment

• deployment/ - Deployment guides
  • README.md - Deployment overview
  • NEBIUS_DEPLOYMENT.md - Nebius deployment guide

Reference

• STRUCTURE.md - Project structure overview
• TESTING.md - Testing guide
• MIGRATION_GUIDE.md - Migration guide
• NEXT_STEPS.md - Next steps and roadmap

Agent Design

• agentdesign.md - AI agent design for automated development workflow

Product Design

• product-design/ - Product design guides and examples
  • Product decision guide
  • RAG setup for product design
  • Example: Tokyo auto insurance product design

🔧 Additional Resources

Data Sources

• guides/estat_api_guide.md - e-Stat API guide
• guides/source_data.md - Data source documentation
• guides/ft_process.md - Fine-tuning process details

Troubleshooting

• guides/TROUBLESHOOTING.md - General troubleshooting
• guides/WEB_TROUBLESHOOTING.md - Web interface troubleshooting

Web Interface

• guides/WEB_INTERFACE.md - Web interface documentation