Skip to content

Commit 9fb4870

Browse files
authored
Update README.md
1 parent 45d2ae5 commit 9fb4870

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ These solvers can solve all the optimization problems implemented in the package
7171
## Quick Start
7272
A simple user example is as follows:
7373
```python
74-
from dro.src.data.dataloader_classification import classification_basic
75-
from dro.src.data.draw_utils import draw_classification
76-
from dro.src.linear_model.chi2_dro import Chi2DRO
74+
from dro.data.dataloader_classification import classification_basic
75+
from dro.data.draw_utils import draw_classification
76+
from dro.linear_model.chi2_dro import Chi2DRO
7777
7878
# Data generating
7979
X, y = classification_basic(d = 2, num_samples = 100, radius = 2, visualize = True)
@@ -105,7 +105,7 @@ As for the latest `v0.3.1` version, `dro` supports:
105105
</tr></thead>
106106
<tbody>
107107
<tr>
108-
<td class="tg-0pky" rowspan="4"><br><br><br><br>dro.src.data.dataloader_classification</td>
108+
<td class="tg-0pky" rowspan="4"><br><br><br><br>dro.data.dataloader_classification</td>
109109
<td class="tg-0pky">classification_basic</td>
110110
<td class="tg-0pky">Basic classification task</td>
111111
</tr>
@@ -122,7 +122,7 @@ As for the latest `v0.3.1` version, `dro` supports:
122122
<td class="tg-0lax">Following Section 4.1 (Classification) of <br>[3]"</td>
123123
</tr>
124124
<tr>
125-
<td class="tg-0lax" rowspan="5"><br><br><br><br><br>dro.src.data.dataloader_regression</td>
125+
<td class="tg-0lax" rowspan="5"><br><br><br><br><br>dro.data.dataloader_regression</td>
126126
<td class="tg-0lax">regression_basic</td>
127127
<td class="tg-0lax">Basic regression task</td>
128128
</tr>
@@ -155,52 +155,52 @@ The models listed below are solved by exact solvers from ``cvxpy``.
155155
</tr></thead>
156156
<tbody>
157157
<tr>
158-
<td class="tg-0lax">dro.src.linear_dro.base</td>
158+
<td class="tg-0lax">dro.linear_dro.base</td>
159159
<td class="tg-0lax">BaseLinearDRO</td>
160160
<td class="tg-0lax">Base class for linear DRO methods</td>
161161
</tr>
162162
<tr>
163-
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.linear_dro.chi2_dro</span></td>
163+
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.linear_dro.chi2_dro</span></td>
164164
<td class="tg-0lax">Chi2DRO</td>
165165
<td class="tg-0lax">Linear chi-square divergence-based DRO</td>
166166
</tr>
167167
<tr>
168-
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.linear_dro.kl_dro</span></td>
168+
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.linear_dro.kl_dro</span></td>
169169
<td class="tg-0lax">KLDRO</td>
170170
<td class="tg-0lax">Kullback-Leibler divergence-based DRO</td>
171171
</tr>
172172
<tr>
173-
<td class="tg-0lax">dro.src.linear_dro.cvar_dro</td>
173+
<td class="tg-0lax">dro.linear_dro.cvar_dro</td>
174174
<td class="tg-0lax">CVaRDRO</td>
175175
<td class="tg-0lax">CVaR DRO</td>
176176
</tr>
177177
<tr>
178-
<td class="tg-0lax">dro.src.linear_dro.tv_dro</td>
178+
<td class="tg-0lax">dro.linear_dro.tv_dro</td>
179179
<td class="tg-0lax">TVDRO</td>
180180
<td class="tg-0lax">Total Variation DRO</td>
181181
</tr>
182182
<tr>
183-
<td class="tg-0lax">dro.src.linear_dro.marginal_dro</td>
183+
<td class="tg-0lax">dro.linear_dro.marginal_dro</td>
184184
<td class="tg-0lax">MarginalCVaRDRO</td>
185185
<td class="tg-0lax">Marginal-X CVaR DRO</td>
186186
</tr>
187187
<tr>
188-
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.linear_dro.mmd_dro</span></td>
188+
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.linear_dro.mmd_dro</span></td>
189189
<td class="tg-0lax">MMD_DRO</td>
190190
<td class="tg-0lax">Maximum Mean Discrepancy DRO</td>
191191
</tr>
192192
<tr>
193-
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.linear_dro.conditional_dro</span></td>
193+
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.linear_dro.conditional_dro</span></td>
194194
<td class="tg-0lax">ConditionalCVaRDRO</td>
195195
<td class="tg-0lax">Y|X (ConditionalShiftBased) CVaR DRO</td>
196196
</tr>
197197
<tr>
198-
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.linear_dro.hr_dro</span></td>
198+
<td class="tg-0lax"><span style="font-weight:400;font-style:normal;text-decoration:none">dro.linear_dro.hr_dro</span></td>
199199
<td class="tg-0lax">HR_DRO_LR</td>
200200
<td class="tg-0lax">Holistic Robust DRO on linear models</td>
201201
</tr>
202202
<tr>
203-
<td class="tg-0lax" rowspan="2"><br><br><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.linear_dro.wasserstein_dro</span></td>
203+
<td class="tg-0lax" rowspan="2"><br><br><span style="font-weight:400;font-style:normal;text-decoration:none">dro.linear_dro.wasserstein_dro</span></td>
204204
<td class="tg-0lax">WassersteinDRO</td>
205205
<td class="tg-0lax">Wasserstein DRO</td>
206206
</tr>
@@ -209,17 +209,17 @@ The models listed below are solved by exact solvers from ``cvxpy``.
209209
<td class="tg-0lax">Robust satisficing version of Wasserstein DRO</td>
210210
</tr>
211211
<tr>
212-
<td class="tg-0lax">dro.src.linear_dro.sinkhorn_dro</td>
212+
<td class="tg-0lax">dro.linear_dro.sinkhorn_dro</td>
213213
<td class="tg-0lax">SinkhornLinearDRO</td>
214214
<td class="tg-0lax">Sinkhorn DRO on linear models</td>
215215
</tr>
216216
<tr>
217-
<td class="tg-0lax">dro.src.linear_dro.mot_dro</td>
217+
<td class="tg-0lax">dro.linear_dro.mot_dro</td>
218218
<td class="tg-0lax">MOTDRO</td>
219219
<td class="tg-0lax">Optimal Transport DRO with Conditional Moment Constraints</td>
220220
</tr>
221221
<tr>
222-
<td class="tg-0lax">dro.src.linear_dro.or_wasserstein_dro</td>
222+
<td class="tg-0lax">dro.linear_dro.or_wasserstein_dro</td>
223223
<td class="tg-0lax">ORWDRO</td>
224224
<td class="tg-0lax">Outlier-Robust Wasserstein DRO</td>
225225
</tr>
@@ -240,22 +240,22 @@ The models listed below are solved by gradient descent (``Pytorch``).
240240
</tr></thead>
241241
<tbody>
242242
<tr>
243-
<td class="tg-0lax">dro.src.neural_model.base_nn</td>
243+
<td class="tg-0lax">dro.neural_model.base_nn</td>
244244
<td class="tg-0lax">BaseNNDRO</td>
245245
<td class="tg-0lax">Base model for neural-network-based DRO</td>
246246
</tr>
247247
<tr>
248-
<td class="tg-0lax">dro.src.neural_model.fdro_nn</td>
248+
<td class="tg-0lax">dro.neural_model.fdro_nn</td>
249249
<td class="tg-0lax">Chi2NNDRO</td>
250250
<td class="tg-0lax">Chi-square Divergence-based Neural DRO Model</td>
251251
</tr>
252252
<tr>
253-
<td class="tg-0lax">dro.src.neural_model.wdro_nn</td>
253+
<td class="tg-0lax">dro.neural_model.wdro_nn</td>
254254
<td class="tg-0lax">WNNDRO</td>
255255
<td class="tg-0lax">Wasserstein Neural DRO with Adversarial Robustness.</td>
256256
</tr>
257257
<tr>
258-
<td class="tg-0lax">dro.src.neural_model.hrdro_nn</td>
258+
<td class="tg-0lax">dro.neural_model.hrdro_nn</td>
259259
<td class="tg-0lax">HRNNDRO</td>
260260
<td class="tg-0lax">Holistic Robust NN DRO</td>
261261
</tr>
@@ -272,7 +272,7 @@ The models listed below are solved by function approximation (``xgboost``, ``lig
272272
<th class="tg-0lax">Description</th>
273273
</tr></thead>
274274
<tbody>
275-
<td class="tg-0lax" rowspan="3"><br><br><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.tree_model.lgbm</span></td>
275+
<td class="tg-0lax" rowspan="3"><br><br><span style="font-weight:400;font-style:normal;text-decoration:none">dro.tree_model.lgbm</span></td>
276276
<td class="tg-0lax">KLDRO_LGBM</td>
277277
<td class="tg-0lax">KL Divergence-based Robust LightGBM</td>
278278
</tr>
@@ -287,7 +287,7 @@ The models listed below are solved by function approximation (``xgboost``, ``lig
287287
<td class="tg-0lax">CVaRDRO_LGBM</td>
288288
<td class="tg-0lax">CVaR Robust LightGBM</td>
289289
</tr>
290-
<td class="tg-0lax" rowspan="3"><br><br><span style="font-weight:400;font-style:normal;text-decoration:none">dro.src.tree_model.xgb</span></td>
290+
<td class="tg-0lax" rowspan="3"><br><br><span style="font-weight:400;font-style:normal;text-decoration:none">dro.tree_model.xgb</span></td>
291291
<td class="tg-0lax">KLDRO_XGB</td>
292292
<td class="tg-0lax">KL Divergence-based Robust XGBoost</td>
293293
</tr>

0 commit comments

Comments
 (0)