You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ General information about the deployed XGBoost classifier, the used data, their
31
31
32
32
Regarding software engineering principles, beside documentation, logging and python style, we create _unit tests_. Slice validation and the tests are incorporated into a _CI/CD framework_ using GitHub Actions. Then, the model is deployed using the [_FastAPI_](https://fastapi.tiangolo.com/) web framework and [_Render_](https://dashboard.render.com/#) as open-source web service.
33
33
34
-
The Unit tests are written via _pytest_for GET and POST prediction requests for the FastAPI component as well as for the mentioned data and model task parts. All unit test results are reported in associated html files of the [tests directory](https://github.com/IloBe/US_CensusData_Classifier_PipelineWithDeployment/tree/master/tests).
34
+
The unit tests are written via [_pytest_](https://docs.pytest.org/en/7.1.x/explanation/goodpractices.html#src-layout) for GET and POST prediction requests for the FastAPI component as well as for the mentioned data and model task parts. All unit test results are reported in associated html files of the [tests directory](https://github.com/IloBe/US_CensusData_Classifier_PipelineWithDeployment/tree/master/tests).
35
35
36
36
All project relevant configuration values, including model hyperparameter ranges for the cross validation concept, are handled via specific configuration _config.yml_ file.<br>
37
37
For versioning tasks, [_git_](https://git-scm.com/) and [_dvc_](https://dvc.org/doc/use-cases/versioning-data-and-models), handled with ignore files content, are chosen. If a remote storage, like AWS S3 or Azure shall be used as future task, dvc[all] for the selected dvc version is installed via requirements.txt file as well for specific configuration. By now, only dvc 'local' remote is set.
@@ -106,12 +106,12 @@ Several other insights are visualised and stored as .png files. So, have a look
106
106
107
107
...
108
108
```
109
-
* As mentioned, the model card informs about our found insights of the binary classification estimator including evaluation diagrams and general metrics.
109
+
* As mentioned, the [Model Card](https://github.com/IloBe/US_CensusData_Classifier_PipelineWithDeployment/blob/master/model_card.md) informs about our found insights of the binary classification estimator including evaluation diagrams and general metrics.
110
110
<br>
111
111
112
112
113
113
## API Creation
114
-
* As Web framework to create a RESTful API _fastapi_ is chosen for app implementation. A _pydantic__BaseModel_ instance handels the POST body, e.g. dealing with hyphens in data feature names which is not allowed in Python.
114
+
* As web framework to create a RESTful API [_FastAPI_](https://fastapi.tiangolo.com/) is chosen for app implementation. A _pydantic__BaseModel_ instance handels the POST body, e.g. dealing with hyphens in data feature names which is not allowed in Python.
115
115
116
116
* As high performance ASGI server [uvicorn](https://www.uvicorn.org/) is selected. The FastAPI web app _uvicorn_ server can be started in the projects root directory via CLI python command:
0 commit comments