ml_project/docs/index.md

29 lines
829 B
Markdown

# Test Score Predictor
## Overview
This is a machine learning service that predicts test scores based on the number of hours studied. The service uses a pre-trained linear regression model and provides both a web interface and API endpoints for predictions.
## Features
- Test score prediction based on study hours
- Web interface for easy interaction
- RESTful API for programmatic access
- Containerized with Docker
- CI/CD pipeline with GitHub Actions
- Environment variable configuration
## Architecture
The service is built using:
- FastAPI for the web framework
- Scikit-learn for the machine learning model (Linear Regression)
- Docker for containerization
- GitHub Actions for CI/CD
## Documentation
- [API Reference](api-reference.md)
- [Model Information](model-info.md)
- [Getting Started](getting-started.md)