docs update - code block

README.md

@@ -5,49 +5,75 @@
 An interactive tool demonstrating credit risk modelling.
 
 Emphasis on:
-* Building models
-* Comparing techniques
-* Interpretating results
+
+- Building models
+- Comparing techniques
+- Interpretating results
 
 ## Built With
 
 - [Streamlit](https://streamlit.io/)
 
-### Hardware initially built on:
+#### Hardware initially built on:
+
 Processor: 11th Gen Intel(R) Core(TM) i7-1165G7 @2.80Ghz, 2803 Mhz, 4 Core(s), 8 Logical Processor(s)
 
-Memory (RAM): 16GB 
+Memory (RAM): 16GB
 
 ## Local setup
+
 ### Obtain the repo locally and open its root folder
+
 #### To potentially contribute
+
+```shell
 git clone https://github.com/pkiage/tool-credit-risk-modelling.git
+```
 
 or
 
+```shell
 gh repo clone pkiage/tool-credit-risk-modelling
+```
 
 #### Just to deploy locally
+
 Download ZIP
 
 ### (optional) Setup virtual environment:
+
+```shell
 python -m venv venv
+```
 
 ### (optional) Activate virtual environment:
-#### If using Unix based OS run the following in terminal:  
+
+#### If using Unix based OS run the following in terminal:
+
+```shell
 .\venv\bin\activate
+```
 
 #### If using Windows run the following in terminal:
+
+```shell
 .\venv\Scripts\activate
+```
 
 ### Install requirements by running the following in terminal:
+
 #### Required packages
+
+```shell
 pip install -r requirements.txt
+```
 
 #### Complete graphviz installation
-https://graphviz.org/download/ 
+
+https://graphviz.org/download/
 
 ## Build and install local package
+
 ```shell
 python setup.py build
 ```
@@ -58,76 +84,88 @@ python setup.py install
 
 ### Run the streamlit app (app.py) by running the following in terminal (from repository root folder):
 
+```shell
 streamlit run src/app.py
+```
 
 ## Deployed setup details
-For faster model building and testing (particularly XGBoost) a local setup or on a more powerful server than free heroku dyno type is recommended. ([tutorials on  servers for data science & ML](https://course.fast.ai))
-
-[Free Heroku dyno type](https://devcenter.heroku.com/articles/dyno-types) was used to deploy the app
 
+For faster model building and testing (particularly XGBoost) a local setup or on a more powerful server than free heroku dyno type is recommended. ([tutorials on servers for data science & ML](https://course.fast.ai))
 
+[Free Heroku dyno type](https://devcenter.heroku.com/articles/dyno-types) was used to deploy the app
 
 Memory (RAM): 512 MB
 
 CPU Share: 1x
 
-Compute: 1x-4x 
+Compute: 1x-4x
 
 Dedicated: no
 
 Sleeps: yes
 
 # Roadmap
+
 Models:
+
 - [ ] Add LightGBM
 - [ ] Add Adabost
 - [ ] Add Random Forest
 
 Visualization:
+
 - [ ] Add decision surface plot(s)
 
 Documentation:
+
 - [x] Add getting started and usage documentation
 - [ ] Add documentation evaluating models
 - [ ] Add design rationale(s)
 
 Other:
+
 - [x] Deploy app
 - [ ] Add csv file data input
 - [ ] Add tests
 - [ ] Add test/code coverage badge
 - [ ] Add continuous integration badge
 
-
-
 # Docs creation
+
 ## [pydeps](https://github.com/thebjorn/pydeps) Python module depenency visualization
 
-*Delete __init__.py and __main__.py* then run the following
+_Delete **init**.py and **main**.py_ then run the following
 
 ### App and clusters
+
 ```shell
 pydeps src/app.py --max-bacon=5 --cluster --rankdir BT -o docs/module-dependency-graph/src-app-clustered.svg
 ```
 
 ### App and links
+
 Features, models, & visualization links:
+
 ```shell
-pydeps src/app.py --only features models visualization --max-bacon=4 --rankdir BT -o docs/module-dependency-graph/src-feature-model-visualization.svg 
+pydeps src/app.py --only features models visualization --max-bacon=4 --rankdir BT -o docs/module-dependency-graph/src-feature-model-visualization.svg
 ```
 
 ### Only features
+
 ```shell
-pydeps src/app.py  --only features --max-bacon=5 --cluster --max-cluster-size=3  --rankdir BT -o docs/module-dependency-graph/src-features.svg 
+pydeps src/app.py  --only features --max-bacon=5 --cluster --max-cluster-size=3  --rankdir BT -o docs/module-dependency-graph/src-features.svg
 ```
 
 ### Only models
+
 ```shell
-pydeps src/app.py  --only models --max-bacon=5 --cluster --max-cluster-size=15  --rankdir BT -o docs/module-dependency-graph/src-models.svg 
+pydeps src/app.py  --only models --max-bacon=5 --cluster --max-cluster-size=15  --rankdir BT -o docs/module-dependency-graph/src-models.svg
 ```
 
 ## [code2flow](https://github.com/scottrogowski/code2flow) Call graphs for a pretty good estimate of project structure
+
 ### Logistic
+
 ```shell
 code2flow src/models/logistic_train_model.py -o docs/call-graph/logistic_train_model.svg
 ```
@@ -137,6 +175,7 @@ code2flow src/models/logistic_model.py -o docs/call-graph/logistic_model.svg
 ```
 
 ### Xgboost
+
 ```shell
 code2flow src/models/xgboost_train_model.py -o docs/call-graph/xgboost_train_model.svg
 ```
@@ -146,6 +185,7 @@ code2flow src/models/xgboost_model.py -o docs/call-graph/xgboost_model.svg
 ```
 
 ### utils
+
 ```shell
 code2flow src/models/util_test.py -o docs/call-graph/util_test.svg
 ```
@@ -162,7 +202,6 @@ code2flow src/models/util_predict_model.py -o docs/call-graph/util_predict_model
 code2flow src/models/util_model_comparison.py -o docs/call-graph/util_model_comparison.svg
 ```
 
-
 # References
 
 ## Inspiration:
@@ -181,6 +220,7 @@ code2flow src/models/util_model_comparison.py -o docs/call-graph/util_model_comp
 - Project structure
 
 [GraphViz Buildpack](https://github.com/weibeld/heroku-buildpack-graphviz)
+
 - Buildpack used for Heroku deployment
 
 ## Political, Economic, Social, Technological, Legal and Environmental(PESTLE):
@@ -190,19 +230,21 @@ code2flow src/models/util_model_comparison.py -o docs/call-graph/util_model_comp
 > "(37) Another area in which the use of AI systems deserves special consideration is the access to and enjoyment of certain essential private and public services and benefits necessary for people to fully participate in society or to improve one’s standard of living. In particular, AI systems used to evaluate the credit score or creditworthiness of natural persons should be classified as high-risk AI systems, since they determine those persons’ access to financial resources or essential services such as housing, electricity, and telecommunication services. AI systems used for this purpose may lead to discrimination of persons or groups and perpetuate historical patterns of discrimination, for example based on racial or ethnic origins, disabilities, age, sexual orientation, or create new forms of discriminatory impacts. Considering the very limited scale of the impact and the available alternatives on the market, it is appropriate to exempt AI systems for the purpose of creditworthiness assessment and credit scoring when put into service by small-scale providers for their own use. Natural persons applying for or receiving public assistance benefits and services from public authorities are typically dependent on those benefits and services and in a vulnerable position in relation to the responsible authorities. If AI systems are used for determining whether such benefits and services should be denied, reduced, revoked or reclaimed by authorities, they may have a significant impact on persons’ livelihood and may infringe their fundamental rights, such as the right to social protection, non-discrimination, human dignity or an effective remedy. Those systems should therefore be classified as high-risk. Nonetheless, this Regulation should not hamper the development and use of innovative approaches in the public administration, which would stand to benefit from a wider use of compliant and safe AI systems, provided that those systems do not entail a high risk to legal and natural persons."
 
 [Europe fit for the Digital Age: Commission proposes new rules and actions for excellence and trust in Artificial Intelligence](https://ec.europa.eu/commission/presscorner/detail/en/ip_21_1682)
+
 > "High-risk AI systems will be subject to strict obligations before they can be put on the market:
->* Adequate risk assessment and mitigation systems;
->* High quality of the datasets feeding the system to minimise risks and discriminatory outcomes;
->* Logging of activity to ensure traceability of results;
->* Detailed documentation providing all information necessary on the system and its purpose for authorities to assess its compliance;
->* Clear and adequate information to the user;
->* Appropriate human oversight measures to minimise risk;
->* High level of robustness, security and accuracy."
+>
+> - Adequate risk assessment and mitigation systems;
+> - High quality of the datasets feeding the system to minimise risks and discriminatory outcomes;
+> - Logging of activity to ensure traceability of results;
+> - Detailed documentation providing all information necessary on the system and its purpose for authorities to assess its compliance;
+> - Clear and adequate information to the user;
+> - Appropriate human oversight measures to minimise risk;
+> - High level of robustness, security and accuracy."
 
 [A list of open problems in DeFi](https://mirror.xyz/0xemperor.eth/0guEj0CYt5V8J5AKur2_UNKyOhONr1QJaG4NGDF0YoQ?utm_source=tldrnewsletter)
-* Automated risk scoring of lending borrowing pools -> Increasingly important problem
-  *  One alternative way of looking at the problem would be, looking at a function for calculating the probability of default given the pool of assets you have.
-* Managing Risk for lenders and distributing risk/ Undercollateralized Loans
-  *  Tradfi is plagued by NPAs [(Nonperforming assets)] but still ultimately fall back to some sort of credit score establishment [[Spectral finance](https://www.spectral.finance/) solving this, but still an open problem].
-  *  But still, most credit score methods would rely on onchain history for credit establishment, we are moving towards privacy-centric defi is this approach extendable to that idea? [Homomorphic encryption could provide a solution]
 
+- Automated risk scoring of lending borrowing pools -> Increasingly important problem
+  - One alternative way of looking at the problem would be, looking at a function for calculating the probability of default given the pool of assets you have.
+- Managing Risk for lenders and distributing risk/ Undercollateralized Loans
+  - Tradfi is plagued by NPAs [(Nonperforming assets)] but still ultimately fall back to some sort of credit score establishment [[Spectral finance](https://www.spectral.finance/) solving this, but still an open problem].
+  - But still, most credit score methods would rely on onchain history for credit establishment, we are moving towards privacy-centric defi is this approach extendable to that idea? [Homomorphic encryption could provide a solution]