pkiage commited on
Commit
05b53a3
·
1 Parent(s): 7592386

Update setup instructions and documentation

Browse files
Files changed (3) hide show
  1. Procfile +1 -1
  2. README.md +58 -0
  3. setup.py +10 -0
Procfile CHANGED
@@ -1 +1 @@
1
- web: sh setup.sh && streamlit run app.py
 
1
+ web: sh setup.sh && streamlit run src/app.py
README.md CHANGED
@@ -47,6 +47,15 @@ pip install -r requirements.txt
47
  #### Complete graphviz installation
48
  https://graphviz.org/download/
49
 
 
 
 
 
 
 
 
 
 
50
  ### Run the streamlit app (app.py) by running the following in terminal:
51
 
52
  streamlit run app.py
@@ -128,3 +137,52 @@ Other:
128
  >* Clear and adequate information to the user;
129
  >* Appropriate human oversight measures to minimise risk;
130
  >* High level of robustness, security and accuracy."
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
  #### Complete graphviz installation
48
  https://graphviz.org/download/
49
 
50
+ ## Build and install local package
51
+ ```shell
52
+ python setup.py build
53
+ ```
54
+
55
+ ```shell
56
+ python setup.py install
57
+ ```
58
+
59
  ### Run the streamlit app (app.py) by running the following in terminal:
60
 
61
  streamlit run app.py
 
137
  >* Clear and adequate information to the user;
138
  >* Appropriate human oversight measures to minimise risk;
139
  >* High level of robustness, security and accuracy."
140
+
141
+
142
+ # Docs creation
143
+ ## [pydeps](https://github.com/thebjorn/pydeps) Python module depenency visualization
144
+
145
+ ```shell
146
+ pydeps src --max-bacon=3 --cluster --max-cluster-size=3 --rankdir BT -o docs/module-dependency-graph/src.svg
147
+ ```
148
+
149
+ ```shell
150
+ pydeps src/app.py --max-bacon=3 --cluster --max-cluster-size=3 --rankdir BT -o docs/module-dependency-graph/app.svg
151
+ ```
152
+
153
+
154
+ ## [code2flow](https://github.com/scottrogowski/code2flow) Call graphs for a pretty good estimate of project structure
155
+ ### Logistic
156
+ ```shell
157
+ code2flow src/models/logistic_train_model.py -o docs/call-graph/logistic_train_model.svg
158
+ ```
159
+
160
+ ```shell
161
+ code2flow src/models/logistic_model.py -o docs/call-graph/logistic_model.svg
162
+ ```
163
+
164
+ ### Xgboost
165
+ ```shell
166
+ code2flow src/models/xgboost_train_model.py -o docs/call-graph/xgboost_train_model.svg
167
+ ```
168
+
169
+ ```shell
170
+ code2flow src/models/xgboost_model.py -o docs/call-graph/xgboost_model.svg
171
+ ```
172
+
173
+ ### utils
174
+ ```shell
175
+ code2flow src/models/util_test.py -o docs/call-graph/util_test.svg
176
+ ```
177
+
178
+ ```shell
179
+ code2flow src/models/util_predict_model_threshold.py -o docs/call-graph/util_predict_model_threshold.svg
180
+ ```
181
+
182
+ ```shell
183
+ code2flow src/models/util_predict_model.py -o docs/call-graph/util_predict_model.svg
184
+ ```
185
+
186
+ ```shell
187
+ code2flow src/models/util_model_comparison.py -o docs/call-graph/util_model_comparison.svg
188
+ ```
setup.py ADDED
@@ -0,0 +1,10 @@
 
 
 
 
 
 
 
 
 
 
 
1
+ from setuptools import find_packages, setup
2
+
3
+ setup(
4
+ name='src',
5
+ packages=find_packages(),
6
+ version='0.1.0',
7
+ description='Tool for credit risk modelling',
8
+ author='Author',
9
+ license='MIT',
10
+ )