humancompatible-train 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. humancompatible_train-0.1.0/LICENCE.txt +201 -0
  2. humancompatible_train-0.1.0/PKG-INFO +188 -0
  3. humancompatible_train-0.1.0/README.md +171 -0
  4. humancompatible_train-0.1.0/experiments/__init__.py +0 -0
  5. humancompatible_train-0.1.0/experiments/calculate_iteration_values.py +310 -0
  6. humancompatible_train-0.1.0/experiments/run_folktables.py +408 -0
  7. humancompatible_train-0.1.0/experiments/run_folktables_torchalgs.py +956 -0
  8. humancompatible_train-0.1.0/humancompatible/__init__.py +0 -0
  9. humancompatible_train-0.1.0/humancompatible/train/__init__.py +3 -0
  10. humancompatible_train-0.1.0/humancompatible/train/algorithms/Algorithm.py +25 -0
  11. humancompatible_train-0.1.0/humancompatible/train/algorithms/__init__.py +8 -0
  12. humancompatible_train-0.1.0/humancompatible/train/algorithms/ghost.py +250 -0
  13. humancompatible_train-0.1.0/humancompatible/train/algorithms/sgd.py +107 -0
  14. humancompatible_train-0.1.0/humancompatible/train/algorithms/ssl_alm.py +311 -0
  15. humancompatible_train-0.1.0/humancompatible/train/algorithms/switching_subgradient.py +192 -0
  16. humancompatible_train-0.1.0/humancompatible/train/algorithms/torch/__init__.py +4 -0
  17. humancompatible_train-0.1.0/humancompatible/train/algorithms/torch/ssl_alm.py +212 -0
  18. humancompatible_train-0.1.0/humancompatible/train/algorithms/torch/ssw.py +155 -0
  19. humancompatible_train-0.1.0/humancompatible/train/algorithms/utils.py +61 -0
  20. humancompatible_train-0.1.0/humancompatible/train/fairness/__init__.py +0 -0
  21. humancompatible_train-0.1.0/humancompatible/train/fairness/constraints/__init__.py +15 -0
  22. humancompatible_train-0.1.0/humancompatible/train/fairness/constraints/constraint.py +97 -0
  23. humancompatible_train-0.1.0/humancompatible/train/fairness/constraints/constraint_fns.py +244 -0
  24. humancompatible_train-0.1.0/humancompatible/train/fairness/constraints/torch/__init__.py +1 -0
  25. humancompatible_train-0.1.0/humancompatible/train/fairness/constraints/torch/constraints.py +36 -0
  26. humancompatible_train-0.1.0/humancompatible/train/fairness/utils/__init__.py +1 -0
  27. humancompatible_train-0.1.0/humancompatible/train/fairness/utils/balanced_batch_sampler.py +65 -0
  28. humancompatible_train-0.1.0/humancompatible_train.egg-info/PKG-INFO +188 -0
  29. humancompatible_train-0.1.0/humancompatible_train.egg-info/SOURCES.txt +33 -0
  30. humancompatible_train-0.1.0/humancompatible_train.egg-info/dependency_links.txt +1 -0
  31. humancompatible_train-0.1.0/humancompatible_train.egg-info/requires.txt +6 -0
  32. humancompatible_train-0.1.0/humancompatible_train.egg-info/top_level.txt +2 -0
  33. humancompatible_train-0.1.0/pyproject.toml +27 -0
  34. humancompatible_train-0.1.0/setup.cfg +4 -0
  35. humancompatible_train-0.1.0/setup.py +7 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 AutoFair
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,188 @@
1
+ Metadata-Version: 2.4
2
+ Name: humancompatible-train
3
+ Version: 0.1.0
4
+ Summary: PyTorch-based package for constrained training of neural networks
5
+ Author: Gilles Bareilles, Jana Lepsova, Jakub Marecek
6
+ Author-email: Andrii Kliachkin <kliachkin.andrii@gmail.com>
7
+ Maintainer-email: Andrii Kliachkin <kliachkin.andrii@gmail.com>
8
+ Requires-Python: >=3.11
9
+ Description-Content-Type: text/markdown
10
+ License-File: LICENCE.txt
11
+ Requires-Dist: torch
12
+ Requires-Dist: numpy
13
+ Provides-Extra: ghost
14
+ Requires-Dist: qpsolvers; extra == "ghost"
15
+ Requires-Dist: scipy; extra == "ghost"
16
+ Dynamic: license-file
17
+
18
+ # Benchmarking Stochastic Approximation Algorithms for Fairness-Constrained Training of Deep Neural Networks
19
+
20
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Setup](https://github.com/humancompatible/train/actions/workflows/setup.yml/badge.svg)](https://github.com/humancompatible/train/actions/workflows/setup.yml)
21
+
22
+ The toolkit implements algorithms for constrained training of neural networks based on PyTorch, and inspired by PyTorch's API, as well as a tool to compare stochastic-constrained stochastic optimization algorithms on a _fair learning_ task in the `experiments` folder.
23
+
24
+ ## Table of Contents
25
+ 1. [Basic installation instructions](#basic-installation-instructions)
26
+ 2. [Using the toolkit](#using-the-toolkit)
27
+ 3. [Reproducing the Benchmark](#reproducing-the-benchmark)
28
+ 4. [Extending the toolkit](#extending-the-toolkit) <!-- 6. [Citing humancompatible/train](#Citing-humancompatible/train) -->
29
+ 5. [License and terms of use](#license-and-terms-of-use)
30
+ 6. [References](#references)
31
+
32
+ Humancompatible/train is still under active development! If you find bugs or have feature
33
+ requests, please file a
34
+ [Github issue](https://github.com/humancompatible/train/issues).
35
+
36
+ ## Basic installation instructions
37
+ The code requires Python version ```3.11```.
38
+
39
+ 1. Create a virtual environment
40
+
41
+ **bash** (Linux)
42
+ ```
43
+ python3.11 -m venv fairbenchenv
44
+ source fairbenchenv/bin/activate
45
+ ```
46
+ **cmd** (Windows)
47
+ ```
48
+ python -m venv fairbenchenv
49
+ fairbenchenv\Scripts\activate.bat
50
+ ```
51
+ 2. Install from source.
52
+ ```
53
+ git clone https://github.com/humancompatible/train.git
54
+ cd train
55
+ pip install -r requirements.txt
56
+ pip install .
57
+ ```
58
+
59
+ If you wish to edit the code of the algorithms, install as an editable package:
60
+ ```
61
+ pip install -e .
62
+ ```
63
+
64
+ __Warning__: it is recommended to use Stochastic Ghost with the mkl-accelerated version of the scipy package with Stochastic Ghost; to install it, run
65
+
66
+ ```pip install --force-reinstall -i https://software.repos.intel.com/python/pypi scipy```
67
+
68
+ after installing requirements.txt; otherwise, the algorithm will run slower. However, this is not supported on MacOS and may fail on some Windows devices.
69
+
70
+ <!-- Install via pip -->
71
+ <!-- ``` -->
72
+ <!-- pip install folktables -->
73
+ <!-- ``` -->
74
+
75
+ ## Using the toolkit
76
+
77
+ The toolkit implements algorithms for constrained training of neural networks based on PyTorch, and inspired by PyTorch's API.
78
+
79
+ ### Code examples
80
+
81
+ You are invited to check out the new API presented in notebooks in the `examples` folder.
82
+
83
+ The algorithms follow the `dual_step()` - `step()` framework: taking inspiration from PyTorch, the `double_step` does updates related to the dual parameters and prepares for the primal update (by, e.g., saving constraint gradients), and `step()` updates the primal parameters.
84
+
85
+ The idea is to make different algorithms nearly interchangable in the code.
86
+
87
+ The legacy API used for the benchmark is presented in `examples/_old_/algorithm_demo.ipynb` and `examples/_old_/constraint_demo.ipynb`.
88
+
89
+ ## Reproducing the Benchmark
90
+
91
+ ### Running the algorithms
92
+
93
+ The benchmark comprises the following algorithms:
94
+ - Stochastic Ghost [[2]](#2),
95
+ - SSL-ALM [[3]](#3),
96
+ - Stochastic Switching Subgradient [[4]](#4).
97
+
98
+ To reproduce the experiments of the paper, run the following:
99
+ ``` python
100
+ cd experiments
101
+ python run_folktables.py data=folktables alg=sslalm
102
+ python run_folktables.py data=folktables alg=alm
103
+ python run_folktables.py data=folktables alg=ghost
104
+ python run_folktables.py data=folktables alg=ssg
105
+ python run_folktables.py data=folktables alg=sgd # baseline, no fairness
106
+ python run_folktables.py data=folktables alg=fairret # baseline, fairness with regularizer
107
+ ```
108
+ Each command will start 10 runs of the `alg`, 30 seconds each.
109
+ The results will be saved to `experiments/utils/saved_models` and `experiments/utils/exp_results`.
110
+ <!-- In the repository, we include the configuration needed to reproduce the experiments in the paper. To do so, go to `experiments` and run `python run_folktables.py data=folktables alg=sslalm`. -->
111
+ <!-- Repeat for the other algorithms by changing the `alg` parameter. -->
112
+
113
+ This repository uses [Hydra](https://hydra.cc/) to manage parameters; see `experiments/conf` for configuration files.
114
+ * To change the parameters of the experiment, such as the number of runs for each algorithm, run time, the dataset used (*note: for now supports only Folktables*) - use `experiment.yaml`.
115
+ * To change the dataset settings - such as file location - or do dataset-specific adjustments - such as the configuration of the protected attributes - use `data/{dataset_name}.yaml`
116
+ * To change algorithm hyperparameters, use `alg/{algorithm_name}.yaml`.
117
+ * To change constraint hyperparameters, use `constraint/{constraint_name}.yaml`
118
+
119
+ <!-- ; it is installed as one of the dependencies. -->
120
+ <!-- To learn more about using Hydra, please check out the [official tutorial](https://hydra.cc/docs/tutorials/basic/your_first_app). -->
121
+
122
+ ### Producing plots
123
+ The plots and tables like the ones in the paper can be produced using the two notebooks. `experiments/algo_plots.ipynb` houses the convergence plots, and `experiments/model_plots.ipynb` - all the others.
124
+
125
+ ## Extending the toolkit
126
+
127
+ ### Adding new code
128
+
129
+ **To add a new algorithm**, you can subclass the PyTorch ```Optimizer``` class and proceed following the API guideline presented above.
130
+
131
+ ## License and terms of use
132
+
133
+ humancompatible/train is provided under the Apache 2.0 Licence.
134
+
135
+ The benchmark part of the package relies on the Folktables package, provided under MIT Licence.
136
+ It provides code to download data from the American Community Survey
137
+ (ACS) Public Use Microdata Sample (PUMS) files managed by the US Census Bureau.
138
+ The data itself is governed by the terms of use provided by the Census Bureau.
139
+ For more information, see https://www.census.gov/data/developers/about/terms-of-service.html
140
+
141
+ <!-- ## Cite this work -->
142
+
143
+ <!-- If you use this work, we encourage you to cite our paper, and the folktables dataset [[1]](#1). -->
144
+
145
+ <!-- ``` -->
146
+ <!-- @article{ding2021retiring, -->
147
+ <!-- title={Retiring Adult: New Datasets for Fair Machine Learning}, -->
148
+ <!-- author={Ding, Frances and Hardt, Moritz and Miller, John and Schmidt, Ludwig}, -->
149
+ <!-- journal={Advances in Neural Information Processing Systems}, -->
150
+ <!-- volume={34}, -->
151
+ <!-- year={2021} -->
152
+ <!-- } -->
153
+ <!-- ``` -->
154
+
155
+ ## Future work
156
+
157
+ - Add more algorithms with PyTorch-like API
158
+ - Add more examples from different fields where constrained training of DNNs is employed
159
+ - Migrate the benchmark to the new API
160
+
161
+ ## References
162
+
163
+ If you use this work, we encourage you to cite [our paper](https://arxiv.org/abs/2507.04033),
164
+
165
+ ```
166
+ @misc{kliachkin2025benchmarkingstochasticapproximationalgorithms,
167
+ title={Benchmarking Stochastic Approximation Algorithms for Fairness-Constrained Training of Deep Neural Networks},
168
+ author={Andrii Kliachkin and Jana Lepšová and Gilles Bareilles and Jakub Mareček},
169
+ year={2025},
170
+ eprint={2507.04033},
171
+ archivePrefix={arXiv},
172
+ primaryClass={cs.LG},
173
+ url={https://arxiv.org/abs/2507.04033},
174
+ }
175
+ ```
176
+
177
+ <a id="1">[1]</a>
178
+ Ding, Hardt & Miller et al. (2021) Retiring Adult: New Datasets for Fair Machine Learning, Curran Associates, Inc..
179
+
180
+ <a id="2">[2]</a>
181
+ Facchinei & Kungurtsev (2023) Stochastic Approximation for Expectation Objective and Expectation Inequality-Constrained Nonconvex Optimization, arXiv.
182
+
183
+ <a id="3">[3]</a>
184
+ Huang, Zhang & Alacaoglu (2025) Stochastic Smoothed Primal-Dual Algorithms for Nonconvex Optimization with Linear Inequality Constraints, arXiv.
185
+
186
+ <a id="4">[4]</a>
187
+ Huang & Lin (2023) Oracle Complexity of Single-Loop Switching Subgradient Methods for Non-Smooth Weakly Convex Functional Constrained Optimization, Curran Associates Inc..
188
+
@@ -0,0 +1,171 @@
1
+ # Benchmarking Stochastic Approximation Algorithms for Fairness-Constrained Training of Deep Neural Networks
2
+
3
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Setup](https://github.com/humancompatible/train/actions/workflows/setup.yml/badge.svg)](https://github.com/humancompatible/train/actions/workflows/setup.yml)
4
+
5
+ The toolkit implements algorithms for constrained training of neural networks based on PyTorch, and inspired by PyTorch's API, as well as a tool to compare stochastic-constrained stochastic optimization algorithms on a _fair learning_ task in the `experiments` folder.
6
+
7
+ ## Table of Contents
8
+ 1. [Basic installation instructions](#basic-installation-instructions)
9
+ 2. [Using the toolkit](#using-the-toolkit)
10
+ 3. [Reproducing the Benchmark](#reproducing-the-benchmark)
11
+ 4. [Extending the toolkit](#extending-the-toolkit) <!-- 6. [Citing humancompatible/train](#Citing-humancompatible/train) -->
12
+ 5. [License and terms of use](#license-and-terms-of-use)
13
+ 6. [References](#references)
14
+
15
+ Humancompatible/train is still under active development! If you find bugs or have feature
16
+ requests, please file a
17
+ [Github issue](https://github.com/humancompatible/train/issues).
18
+
19
+ ## Basic installation instructions
20
+ The code requires Python version ```3.11```.
21
+
22
+ 1. Create a virtual environment
23
+
24
+ **bash** (Linux)
25
+ ```
26
+ python3.11 -m venv fairbenchenv
27
+ source fairbenchenv/bin/activate
28
+ ```
29
+ **cmd** (Windows)
30
+ ```
31
+ python -m venv fairbenchenv
32
+ fairbenchenv\Scripts\activate.bat
33
+ ```
34
+ 2. Install from source.
35
+ ```
36
+ git clone https://github.com/humancompatible/train.git
37
+ cd train
38
+ pip install -r requirements.txt
39
+ pip install .
40
+ ```
41
+
42
+ If you wish to edit the code of the algorithms, install as an editable package:
43
+ ```
44
+ pip install -e .
45
+ ```
46
+
47
+ __Warning__: it is recommended to use Stochastic Ghost with the mkl-accelerated version of the scipy package with Stochastic Ghost; to install it, run
48
+
49
+ ```pip install --force-reinstall -i https://software.repos.intel.com/python/pypi scipy```
50
+
51
+ after installing requirements.txt; otherwise, the algorithm will run slower. However, this is not supported on MacOS and may fail on some Windows devices.
52
+
53
+ <!-- Install via pip -->
54
+ <!-- ``` -->
55
+ <!-- pip install folktables -->
56
+ <!-- ``` -->
57
+
58
+ ## Using the toolkit
59
+
60
+ The toolkit implements algorithms for constrained training of neural networks based on PyTorch, and inspired by PyTorch's API.
61
+
62
+ ### Code examples
63
+
64
+ You are invited to check out the new API presented in notebooks in the `examples` folder.
65
+
66
+ The algorithms follow the `dual_step()` - `step()` framework: taking inspiration from PyTorch, the `double_step` does updates related to the dual parameters and prepares for the primal update (by, e.g., saving constraint gradients), and `step()` updates the primal parameters.
67
+
68
+ The idea is to make different algorithms nearly interchangable in the code.
69
+
70
+ The legacy API used for the benchmark is presented in `examples/_old_/algorithm_demo.ipynb` and `examples/_old_/constraint_demo.ipynb`.
71
+
72
+ ## Reproducing the Benchmark
73
+
74
+ ### Running the algorithms
75
+
76
+ The benchmark comprises the following algorithms:
77
+ - Stochastic Ghost [[2]](#2),
78
+ - SSL-ALM [[3]](#3),
79
+ - Stochastic Switching Subgradient [[4]](#4).
80
+
81
+ To reproduce the experiments of the paper, run the following:
82
+ ``` python
83
+ cd experiments
84
+ python run_folktables.py data=folktables alg=sslalm
85
+ python run_folktables.py data=folktables alg=alm
86
+ python run_folktables.py data=folktables alg=ghost
87
+ python run_folktables.py data=folktables alg=ssg
88
+ python run_folktables.py data=folktables alg=sgd # baseline, no fairness
89
+ python run_folktables.py data=folktables alg=fairret # baseline, fairness with regularizer
90
+ ```
91
+ Each command will start 10 runs of the `alg`, 30 seconds each.
92
+ The results will be saved to `experiments/utils/saved_models` and `experiments/utils/exp_results`.
93
+ <!-- In the repository, we include the configuration needed to reproduce the experiments in the paper. To do so, go to `experiments` and run `python run_folktables.py data=folktables alg=sslalm`. -->
94
+ <!-- Repeat for the other algorithms by changing the `alg` parameter. -->
95
+
96
+ This repository uses [Hydra](https://hydra.cc/) to manage parameters; see `experiments/conf` for configuration files.
97
+ * To change the parameters of the experiment, such as the number of runs for each algorithm, run time, the dataset used (*note: for now supports only Folktables*) - use `experiment.yaml`.
98
+ * To change the dataset settings - such as file location - or do dataset-specific adjustments - such as the configuration of the protected attributes - use `data/{dataset_name}.yaml`
99
+ * To change algorithm hyperparameters, use `alg/{algorithm_name}.yaml`.
100
+ * To change constraint hyperparameters, use `constraint/{constraint_name}.yaml`
101
+
102
+ <!-- ; it is installed as one of the dependencies. -->
103
+ <!-- To learn more about using Hydra, please check out the [official tutorial](https://hydra.cc/docs/tutorials/basic/your_first_app). -->
104
+
105
+ ### Producing plots
106
+ The plots and tables like the ones in the paper can be produced using the two notebooks. `experiments/algo_plots.ipynb` houses the convergence plots, and `experiments/model_plots.ipynb` - all the others.
107
+
108
+ ## Extending the toolkit
109
+
110
+ ### Adding new code
111
+
112
+ **To add a new algorithm**, you can subclass the PyTorch ```Optimizer``` class and proceed following the API guideline presented above.
113
+
114
+ ## License and terms of use
115
+
116
+ humancompatible/train is provided under the Apache 2.0 Licence.
117
+
118
+ The benchmark part of the package relies on the Folktables package, provided under MIT Licence.
119
+ It provides code to download data from the American Community Survey
120
+ (ACS) Public Use Microdata Sample (PUMS) files managed by the US Census Bureau.
121
+ The data itself is governed by the terms of use provided by the Census Bureau.
122
+ For more information, see https://www.census.gov/data/developers/about/terms-of-service.html
123
+
124
+ <!-- ## Cite this work -->
125
+
126
+ <!-- If you use this work, we encourage you to cite our paper, and the folktables dataset [[1]](#1). -->
127
+
128
+ <!-- ``` -->
129
+ <!-- @article{ding2021retiring, -->
130
+ <!-- title={Retiring Adult: New Datasets for Fair Machine Learning}, -->
131
+ <!-- author={Ding, Frances and Hardt, Moritz and Miller, John and Schmidt, Ludwig}, -->
132
+ <!-- journal={Advances in Neural Information Processing Systems}, -->
133
+ <!-- volume={34}, -->
134
+ <!-- year={2021} -->
135
+ <!-- } -->
136
+ <!-- ``` -->
137
+
138
+ ## Future work
139
+
140
+ - Add more algorithms with PyTorch-like API
141
+ - Add more examples from different fields where constrained training of DNNs is employed
142
+ - Migrate the benchmark to the new API
143
+
144
+ ## References
145
+
146
+ If you use this work, we encourage you to cite [our paper](https://arxiv.org/abs/2507.04033),
147
+
148
+ ```
149
+ @misc{kliachkin2025benchmarkingstochasticapproximationalgorithms,
150
+ title={Benchmarking Stochastic Approximation Algorithms for Fairness-Constrained Training of Deep Neural Networks},
151
+ author={Andrii Kliachkin and Jana Lepšová and Gilles Bareilles and Jakub Mareček},
152
+ year={2025},
153
+ eprint={2507.04033},
154
+ archivePrefix={arXiv},
155
+ primaryClass={cs.LG},
156
+ url={https://arxiv.org/abs/2507.04033},
157
+ }
158
+ ```
159
+
160
+ <a id="1">[1]</a>
161
+ Ding, Hardt & Miller et al. (2021) Retiring Adult: New Datasets for Fair Machine Learning, Curran Associates, Inc..
162
+
163
+ <a id="2">[2]</a>
164
+ Facchinei & Kungurtsev (2023) Stochastic Approximation for Expectation Objective and Expectation Inequality-Constrained Nonconvex Optimization, arXiv.
165
+
166
+ <a id="3">[3]</a>
167
+ Huang, Zhang & Alacaoglu (2025) Stochastic Smoothed Primal-Dual Algorithms for Nonconvex Optimization with Linear Inequality Constraints, arXiv.
168
+
169
+ <a id="4">[4]</a>
170
+ Huang & Lin (2023) Oracle Complexity of Single-Loop Switching Subgradient Methods for Non-Smooth Weakly Convex Functional Constrained Optimization, Curran Associates Inc..
171
+
File without changes