Merge pull request #25 from IloBe/10-api-deployment-to-a-cloud-application-platform

Feat: deploy api code and test script

Author: IloBe

README.md

@@ -1,19 +1,19 @@
 [//]: # (Image References)
 [image0]: ./screenshots/MLOps_proj3_tree.PNG "proj3 structure"
-[image1]: ./screenshots/MLOps_proj3_FastAPI_gitHubPrecommitHook.PNG "github action"
+[image1]: ./screenshots/continuous_deployment.png "github action"
 [image2]: ./plots/numFeats_outlierDist_sex_boxplot.png "feat dist by sex plot"
 [image3]: ./plots/general_dist_age-hoursPerWeek_boxplot.png "hours-per-week by age boxplots"
 [image4]: ./plots/salary_dist_hoursPerWeek-age-sex_plot.png "salary dist by age sex plot"
 [image5]: ./plots/capitalGain_dist_age-hoursPerWeek-sex_plot.png "capital gain dist by hours-per-week sex"
 [image6]: ./plots/sex_plot.png  "sex plot"
 [image7]: ./screenshots/education-group_people-count.PNG "education people count"
 [image8]: ./plots/eduLevel_dist_age-race_plot.png "education level grouping by age race"
-[image9]: ./screenshots/MLOps_proj3_FastAPI_docsPredictPersonIncomeNegativeExample.PNG "fastapi income negative"
+[image9]: ./screenshots/example.PNG "fastapi income negative"
 [image10]: ./screenshots/MLOps_proj3_FastAPI_docsPredictPersonIncomeNegativeExample_ResponseCode.PNG "fastapi income negative response"
-[image11]: ./screenshots/render_createNewWebService.PNG "render web service"
-[image12]: ./
-[image13]: ./
-[image14]: ./
+[image11]: ./screenshots/MLOps_proj3_Render_createNewWebService.PNG "render web service"
+[image12]: ./screenshots/MLOps_proj3_Render_webservice_live.PNG "render web service life"
+[image13]: ./screenshots/MLOps_proj3_Render_webservice_live_test_status.PNG "render web service test"
+[image14]: ./screenshots/live_post.png "render web service script result"
 
 
 # US Census Data - Creating and Deploying a Classifier Pipeline as Web Service
@@ -123,9 +123,9 @@ There in "__main__" it calls
   ```
 
 Remember, this code is for development purpose, in production the reload option shall be set to False resp. not used. In other words, the start command e.g. on our render deployment web service (see below) is:<br>
-uvicorn src.main:app
+uvicorn src.main:app --host 0.0.0.0 --port 8000
 
-* So , we start the browser web application with
+* So, locally we start our implemented browser web application with
 
   ```
   http://127.0.0.1:8000/docs
@@ -156,6 +156,13 @@ As an examples regarding the use case of having a person earning <=50K as income
 * Have in mind: if you rely on your CI/CD to fail before fixing an issue, it slows down your deployment. Fix issues early, e.g. by running an ensemble linter like flake8 locally before committing changes.
 * For checking the render deployment, a python file exists that uses the httpx module to do one GET and POST on the live render web service and prints its results. 
 
+On the Render web service site, 
+![render web service life][image12]
+<br>
+![render web service test][image13]
+<br>
+![render web service script result][image14]
+
 
 ## License
 This project coding is released under the [MIT](https://github.com/IloBe/US_CensusData_Classifier_PipelineWithDeployment/blob/master/LICENSE.txt) license.

…reenshots/render_createNewWebService.PNG …Ops_proj3_Render_createNewWebService.PNGscreenshots/render_createNewWebService.PNG renamed to screenshots/MLOps_proj3_Render_createNewWebService.PNG screenshots/render_createNewWebService.PNG renamed to screenshots/MLOps_proj3_Render_createNewWebService.PNG

@@ -22,11 +22,14 @@
 }
 
 # GET, check first feature attribute
-response = httpx.get('https://census-project-xki0.onrender.com/feature_info/age')
-print(response.status_code)
-print(response.json())
+response = httpx.get('https://census-project-xki0.onrender.com/feature_labels/age')
+print('--- Render census-project feature GET life service test ---')
+print(f'response status code: {response.status_code}')
+print(f'response json value: {response.json()}\n')
 
 # POST, check given sample
-response = httpx.post('https://census-project-xki0.onrender.com/predict/', data=sample)
-print(response.status_code)
-print(response.content)
+print('--- Render census-project person data POST life service test ---')
+response = httpx.post('https://census-project-xki0.onrender.com/predict/',
+                      json=sample)
+print(f'response status code: {response.status_code}')
+print(f'response content:\n{response.content}')

screenshots/MLOps_proj3_Render_webservice_live.PNG

@@ -46,11 +46,11 @@ def raw_test_data() -> pd.DataFrame:
 
     Returns:
         Subset dataframe with 1500 rows loaded from original csv file
-    """ 
+    """
     try:
         # data = './df_test_1500raw.csv'
         ROOT = os.getcwd()
-        filepath = os.path.join(ROOT, config_file['etl']['test_data_orig_census'])   
+        filepath = os.path.join(ROOT, config_file['etl']['test_data_orig_census'])
         return pd.read_csv(filepath)
     except Exception as e:
         pytest.fail(f"Fixture with 1500 orig rows: exc: {e}")
@@ -67,7 +67,7 @@ def cleaned_test_data() -> pd.DataFrame:
     try:
         # data = './df_test_1500raw.csv'
         ROOT = os.getcwd()
-        filepath = os.path.join(ROOT, config_file['etl']['test_data_orig_census']) 
+        filepath = os.path.join(ROOT, config_file['etl']['test_data_orig_census'])
         return clean_data(pd.read_csv(filepath)[:200], config_file)
     except Exception as e:
         pytest.fail(f"Fixture with 200 cleaned rows: exc: {e}")