pkiage commited on
Commit
9375d41
1 Parent(s): 8ceebfd

docs: add dependency graphs and update README

Browse files
README.md CHANGED
@@ -100,6 +100,69 @@ Other:
100
 
101
 
102
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
103
  # References
104
 
105
  ## Inspiration:
@@ -145,47 +208,3 @@ Other:
145
  * 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].
146
  * 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]
147
 
148
-
149
- # Docs creation
150
- ## [pydeps](https://github.com/thebjorn/pydeps) Python module depenency visualization
151
-
152
- ```shell
153
- pydeps src --max-bacon=3 --cluster --max-cluster-size=3 --rankdir BT -o docs/module-dependency-graph/src.svg
154
- ```
155
-
156
- ## [code2flow](https://github.com/scottrogowski/code2flow) Call graphs for a pretty good estimate of project structure
157
- ### Logistic
158
- ```shell
159
- code2flow src/models/logistic_train_model.py -o docs/call-graph/logistic_train_model.svg
160
- ```
161
-
162
- ```shell
163
- code2flow src/models/logistic_model.py -o docs/call-graph/logistic_model.svg
164
- ```
165
-
166
- ### Xgboost
167
- ```shell
168
- code2flow src/models/xgboost_train_model.py -o docs/call-graph/xgboost_train_model.svg
169
- ```
170
-
171
- ```shell
172
- code2flow src/models/xgboost_model.py -o docs/call-graph/xgboost_model.svg
173
- ```
174
-
175
- ### utils
176
- ```shell
177
- code2flow src/models/util_test.py -o docs/call-graph/util_test.svg
178
- ```
179
-
180
- ```shell
181
- code2flow src/models/util_predict_model_threshold.py -o docs/call-graph/util_predict_model_threshold.svg
182
- ```
183
-
184
- ```shell
185
- code2flow src/models/util_predict_model.py -o docs/call-graph/util_predict_model.svg
186
- ```
187
-
188
- ```shell
189
- code2flow src/models/util_model_comparison.py -o docs/call-graph/util_model_comparison.svg
190
- ```
191
-
 
100
 
101
 
102
 
103
+ # Docs creation
104
+ ## [pydeps](https://github.com/thebjorn/pydeps) Python module depenency visualization
105
+
106
+ *Delete __init__.py and __main__.py* then run the following
107
+
108
+ ### App and clusters
109
+ ```shell
110
+ pydeps src/app.py --max-bacon=5 --cluster --rankdir BT -o docs/module-dependency-graph/src-app-clustered.svg
111
+ ```
112
+
113
+ ### App and links
114
+ Features, models, & visualization links:
115
+ ```shell
116
+ pydeps src/app.py --only features models visualization --max-bacon=4 --rankdir BT -o docs/module-dependency-graph/src-feature-model-visualization.svg
117
+ ```
118
+
119
+ ### Only features
120
+ ```shell
121
+ pydeps src/app.py --only features --max-bacon=5 --cluster --max-cluster-size=3 --rankdir BT -o docs/module-dependency-graph/src-features.svg
122
+ ```
123
+
124
+ ### Only models
125
+ ```shell
126
+ pydeps src/app.py --only models --max-bacon=5 --cluster --max-cluster-size=15 --rankdir BT -o docs/module-dependency-graph/src-models.svg
127
+ ```
128
+
129
+ ## [code2flow](https://github.com/scottrogowski/code2flow) Call graphs for a pretty good estimate of project structure
130
+ ### Logistic
131
+ ```shell
132
+ code2flow src/models/logistic_train_model.py -o docs/call-graph/logistic_train_model.svg
133
+ ```
134
+
135
+ ```shell
136
+ code2flow src/models/logistic_model.py -o docs/call-graph/logistic_model.svg
137
+ ```
138
+
139
+ ### Xgboost
140
+ ```shell
141
+ code2flow src/models/xgboost_train_model.py -o docs/call-graph/xgboost_train_model.svg
142
+ ```
143
+
144
+ ```shell
145
+ code2flow src/models/xgboost_model.py -o docs/call-graph/xgboost_model.svg
146
+ ```
147
+
148
+ ### utils
149
+ ```shell
150
+ code2flow src/models/util_test.py -o docs/call-graph/util_test.svg
151
+ ```
152
+
153
+ ```shell
154
+ code2flow src/models/util_predict_model_threshold.py -o docs/call-graph/util_predict_model_threshold.svg
155
+ ```
156
+
157
+ ```shell
158
+ code2flow src/models/util_predict_model.py -o docs/call-graph/util_predict_model.svg
159
+ ```
160
+
161
+ ```shell
162
+ code2flow src/models/util_model_comparison.py -o docs/call-graph/util_model_comparison.svg
163
+ ```
164
+
165
+
166
  # References
167
 
168
  ## Inspiration:
 
208
  * 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].
209
  * 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]
210
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
docs/module-dependency-graph/src-app-clustered.svg ADDED
docs/module-dependency-graph/src-feature-model-visualization.svg ADDED
docs/module-dependency-graph/src-features.svg ADDED
docs/module-dependency-graph/src-models.svg ADDED
docs/module-dependency-graph/src.svg DELETED