3v324v23's picture
docs: Add comprehensive documentation for v2.1.1
36bf385
# Changelog
All notable changes to the Chronos2 Excel Add-in project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
---
## [2.1.1] - 2025-11-09
### πŸ› Fixed
- **detectAnomalies()**: Now writes formatted anomaly table to Excel instead of just showing in log
- Adds 6-column table: Index, Value, Expected, Lower, Upper, Is Anomaly
- Highlights anomalies in RED (#FFC7CE)
- Blue header (#4472C4)
- +45 lines of code
- **runBacktest()**: Now writes backtest results to Excel instead of just showing in log
- Adds metrics table (MAE, MAPE, RMSE, WQL) with green header (#70AD47)
- Adds forecast vs actual comparison table with blue header (#4472C4)
- Auto-calculates error column
- +70 lines of code
- **forecastMultiSeries()**: Now writes multi-series results to Excel instead of just showing in log
- Creates one table per series
- Dark blue headers for series names (#4472C4)
- Light blue headers for data columns (#D9E1F2)
- Automatic separation between series
- +51 lines of code
### πŸ“Š Statistics
- Total code added: +148 lines (+15.5%)
- File size: 956 β†’ 1104 lines
- All 7 functions now write formatted output to Excel
### πŸš€ Deployment
- Commit: `ed06bc0`
- Deployed to HuggingFace Space: https://ttzzs-chronos2-excel-forecasting-api.hf.space
- Manifest URL: https://ttzzs-chronos2-excel-forecasting-api.hf.space/manifest.xml
### πŸ“š Documentation
- Added `CORRECCIONES_EXCEL_WRITE.md` - Complete fix documentation
- Added `FIXES_WRITE_TO_EXCEL.md` - Technical analysis
- Updated `README_v2.1.md` - Added output format details
---
## [2.1.0] - 2025-11-09
### ✨ Added
- **Forecast with Covariates**: Include explanatory variables (price, promotions, weather, etc.)
- 138 lines of code
- Tab: Covariates
- Endpoint: `/forecast_with_covariates`
- **Scenario Analysis**: Compare multiple "what-if" scenarios automatically
- 207 lines of code
- Tab: Covariates
- Endpoint: `/forecast_scenarios`
- Generates Base, Optimistic (+20%), and Pessimistic (-20%) scenarios
- **Multivariate Forecast**: Forecast multiple target variables simultaneously
- 134 lines of code
- Tab: Scenarios
- Endpoint: `/forecast_multivariate`
### πŸ“¦ Infrastructure
- Added `/static` directory structure for serving Add-in files
- Updated `app/main.py` with StaticFiles support
- Updated `Dockerfile` to include `/static` directory
- Configured CORS for Office Add-ins (`*` allowed for Office.js)
### πŸš€ Deployment
- Deployed to HuggingFace Space
- Public manifest URL available
- All endpoints verified and working
### πŸ“Š Statistics
- Total functions: 7 (4 existing + 3 new)
- Total code: 956 lines
- Endpoints: 8 API endpoints
- Static files: 11 files
### πŸ“š Documentation
- Added `NUEVAS_FUNCIONES_V2.1.md` - Complete guide to new functions
- Added `README_v2.1.md` - General documentation
- Added `RESUMEN_ACTUALIZACION_ADDON_V2.1.md` - Technical update summary
- Added `PLAN_AGREGAR_ADDON_A_HF.md` - Implementation plan
- Added `DEPLOY_EXITOSO_V2.1.0.md` - Successful deployment report
---
## [2.0.0] - 2025-11-08
### ✨ Initial Release
#### Features
1. **Univariate Forecast**
- Basic time series forecasting
- Quantile predictions (Q10, Median, Q90)
- Tab: Basic
- Endpoint: `/forecast_univariate`
2. **Anomaly Detection**
- Automatic outlier detection
- Context-based analysis
- Tab: Basic
- Endpoint: `/detect_anomalies`
- ⚠️ Only logged to console (fixed in v2.1.1)
3. **Backtest**
- Model accuracy validation
- Metrics: MAE, MAPE, RMSE, WQL
- Tab: Basic
- Endpoint: `/backtest_simple`
- ⚠️ Only logged to console (fixed in v2.1.1)
4. **Multi-Series Forecast**
- Forecast multiple series simultaneously
- Tab: Multi-Series
- Endpoint: `/forecast_multi_id`
- ⚠️ Only logged to console (fixed in v2.1.1)
#### Infrastructure
- FastAPI backend
- Amazon Chronos-2 model
- Office.js integration
- Task pane UI with tabs
- Real-time server status indicator
- Comprehensive logging system
#### Deployment
- Docker support
- HuggingFace Spaces compatible
- Local development mode
- HTTPS support
#### Documentation
- README.md - Project overview
- GETTING_STARTED.md - Installation guide
- API documentation via FastAPI `/docs`
---
## Version Comparison
| Version | Functions | Excel Output | Code Lines | Deploy |
|---------|-----------|--------------|------------|--------|
| 2.0.0 | 4 | 1/4 (25%) | ~800 | βœ… |
| 2.1.0 | 7 | 4/7 (57%) | 956 | βœ… |
| 2.1.1 | 7 | 7/7 (100%) | 1104 | βœ… |
---
## Roadmap
### v2.2.0 (Planned)
- [ ] Automatic chart generation
- [ ] Visual column selector
- [ ] Industry-specific templates (Retail, Finance, E-commerce)
- [ ] Export to PDF
- [ ] Interactive tutorial
### v2.3.0 (Planned)
- [ ] Model caching to reduce cold start
- [ ] JS/CSS minification
- [ ] Professional SVG icons
- [ ] Rate limiting on endpoints
- [ ] Advanced error handling
### v3.0.0 (Future)
- [ ] Support for custom models
- [ ] Real-time streaming data
- [ ] Collaborative forecasting
- [ ] Integration with Power BI
- [ ] Mobile support (Excel Mobile)
---
## Support
- **Issues**: https://github.com/your-repo/issues
- **Documentation**: https://ttzzs-chronos2-excel-forecasting-api.hf.space/docs
- **Manifest**: https://ttzzs-chronos2-excel-forecasting-api.hf.space/manifest.xml
---
## Contributors
- Droid (AI Assistant)
- factory-droid[bot]
---
## License
[Your License Here]