53 lines
1.2 KiB
Markdown
53 lines
1.2 KiB
Markdown
|
# ML API
|
||
|
|
|
||
|
|
> *⚠️ Note: This API is not yet implemented and is planned for a future release.*
|
||
|
|
|
||
|
|
The ML API will provide endpoints for machine learning operations, model training, and predictive analytics.
|
||
|
|
|
||
|
|
## Planned Features
|
||
|
|
|
||
|
|
- Dataset management and preprocessing
|
||
|
|
- Model training and evaluation
|
||
|
|
- Hyperparameter tuning
|
||
|
|
- Batch predictions
|
||
|
|
- Model performance monitoring
|
||
|
|
- A/B testing for models
|
||
|
|
- Feature engineering tools
|
||
|
|
|
||
|
|
## Base URL (Planned)
|
||
|
|
|
||
|
|
```
|
||
|
|
http://localhost:8080/api/v1/ml
|
||
|
|
```
|
||
|
|
|
||
|
|
## Authentication
|
||
|
|
|
||
|
|
Will use the standard BotServer authentication mechanism with appropriate role-based permissions.
|
||
|
|
|
||
|
|
## Endpoints (Planned)
|
||
|
|
|
||
|
|
### Dataset Management
|
||
|
|
`POST /api/v1/ml/datasets`
|
||
|
|
`GET /api/v1/ml/datasets`
|
||
|
|
`DELETE /api/v1/ml/datasets/{dataset_id}`
|
||
|
|
|
||
|
|
### Model Training
|
||
|
|
`POST /api/v1/ml/train`
|
||
|
|
`GET /api/v1/ml/jobs/{job_id}`
|
||
|
|
`POST /api/v1/ml/jobs/{job_id}/stop`
|
||
|
|
|
||
|
|
### Predictions
|
||
|
|
`POST /api/v1/ml/predict`
|
||
|
|
`POST /api/v1/ml/batch-predict`
|
||
|
|
|
||
|
|
### Model Evaluation
|
||
|
|
`GET /api/v1/ml/models/{model_id}/metrics`
|
||
|
|
`POST /api/v1/ml/models/{model_id}/evaluate`
|
||
|
|
|
||
|
|
### Feature Engineering
|
||
|
|
`POST /api/v1/ml/features/extract`
|
||
|
|
`GET /api/v1/ml/features/importance`
|
||
|
|
|
||
|
|
## Implementation Status
|
||
|
|
|
||
|
|
This API is currently in the planning phase. Check back in future releases for availability.
|