Ajout de la documentation et de la configuration Backstage.io
This commit is contained in:
parent
2a7969d0d5
commit
c68c9ccf2a
18
catalog-info.yaml
Normal file
18
catalog-info.yaml
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
apiVersion: backstage.io/v1alpha1
|
||||||
|
kind: Component
|
||||||
|
metadata:
|
||||||
|
name: wine-quality-predictor
|
||||||
|
description: A machine learning service for predicting wine quality based on chemical properties
|
||||||
|
annotations:
|
||||||
|
github.com/project-slug: wine-quality-predictor
|
||||||
|
backstage.io/techdocs-ref: dir:./docs
|
||||||
|
tags:
|
||||||
|
- fastapi
|
||||||
|
- python
|
||||||
|
- machine-learning
|
||||||
|
- wine
|
||||||
|
spec:
|
||||||
|
type: service
|
||||||
|
lifecycle: experimental
|
||||||
|
owner: data-science-team
|
||||||
|
system: ml-services
|
||||||
26
docs/index.md
Normal file
26
docs/index.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
# Wine Quality Predictor
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This is a machine learning service that predicts wine quality based on chemical properties. The service uses a pre-trained machine learning model and provides an API endpoint for predictions.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Wine quality prediction based on chemical properties
|
||||||
|
- RESTful API for programmatic access
|
||||||
|
- Detailed input validation
|
||||||
|
- Comprehensive documentation
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
The service is built using:
|
||||||
|
- FastAPI for the web framework
|
||||||
|
- Scikit-learn for the machine learning model
|
||||||
|
- Pandas and NumPy for data handling
|
||||||
|
- Pydantic for input validation
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
|
||||||
|
- [API Reference](api-reference.md)
|
||||||
|
- [Model Information](model-info.md)
|
||||||
|
- [Getting Started](getting-started.md)
|
||||||
12
mkdocs.yml
Normal file
12
mkdocs.yml
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
site_name: 'Wine Quality Predictor'
|
||||||
|
nav:
|
||||||
|
- Home: index.md
|
||||||
|
- API Reference: api-reference.md
|
||||||
|
- Model Information: model-info.md
|
||||||
|
- Getting Started: getting-started.md
|
||||||
|
plugins:
|
||||||
|
- techdocs-core
|
||||||
|
markdown_extensions:
|
||||||
|
- admonition
|
||||||
|
- pymdownx.highlight
|
||||||
|
- pymdownx.superfences
|
||||||
Loading…
x
Reference in New Issue
Block a user