Skip to content

Commit bce6247

Browse files
authored
Doc: correct misspellings
1 parent bef469e commit bce6247

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ General information about the deployed XGBoost classifier, the used data, their
3131

3232
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.
3333

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).
3535

3636
All project relevant configuration values, including model hyperparameter ranges for the cross validation concept, are handled via specific configuration _config.yml_ file.<br>
3737
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
106106
107107
...
108108
```
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.
110110
<br>
111111

112112

113113
## 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.
115115

116116
* 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:
117117

0 commit comments

Comments
 (0)