mononet 0.0.0a0__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.
@@ -0,0 +1,207 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[cod]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py,cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+ docs/apidocs/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ #Pipfile.lock
97
+
98
+ # UV
99
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ #uv.lock
103
+
104
+ # poetry
105
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
106
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
107
+ # commonly ignored for libraries.
108
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
109
+ #poetry.lock
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ #pdm.lock
114
+ # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
115
+ # in version control.
116
+ # https://pdm.fming.dev/latest/usage/project/#working-with-version-control
117
+ .pdm.toml
118
+ .pdm-python
119
+ .pdm-build/
120
+
121
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
122
+ __pypackages__/
123
+
124
+ # Celery stuff
125
+ celerybeat-schedule
126
+ celerybeat.pid
127
+
128
+ # SageMath parsed files
129
+ *.sage.py
130
+
131
+ # Environments
132
+ .env
133
+ .venv
134
+ env/
135
+ venv/
136
+ ENV/
137
+ env.bak/
138
+ venv.bak/
139
+
140
+ # Spyder project settings
141
+ .spyderproject
142
+ .spyproject
143
+
144
+ # Rope project settings
145
+ .ropeproject
146
+
147
+
148
+ # mypy
149
+ .mypy_cache/
150
+ .dmypy.json
151
+ dmypy.json
152
+
153
+ # Pyre type checker
154
+ .pyre/
155
+
156
+ # pytype static type analyzer
157
+ .pytype/
158
+
159
+ # Cython debug symbols
160
+ cython_debug/
161
+
162
+ # PyCharm
163
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
164
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
165
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
166
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
167
+ #.idea/
168
+
169
+ # Abstra
170
+ # Abstra is an AI-powered process automation framework.
171
+ # Ignore directories containing user credentials, local state, and settings.
172
+ # Learn more at https://abstra.io/docs
173
+ .abstra/
174
+
175
+ # Visual Studio Code
176
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
177
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
178
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
179
+ # you could uncomment the following to ignore the enitre vscode folder
180
+ # .vscode/
181
+
182
+ # Ruff stuff:
183
+ .ruff_cache/
184
+
185
+ # PyPI configuration file
186
+ .pypirc
187
+
188
+ # Cursor
189
+ # Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
190
+ # exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
191
+ # refer to https://docs.cursor.com/context/ignore-files
192
+ .cursorignore
193
+ .cursorindexingignore
194
+
195
+ # MacOS
196
+ .DS_Store
197
+ .AppleDouble
198
+ .LSOverride
199
+ .AppleDB
200
+ .AppleDesktop
201
+ .apdisk
202
+ *.icloud
203
+
204
+ # Superpowers brainstorming visual-companion artifacts
205
+ .superpowers/
206
+
207
+ # Documentation
@@ -0,0 +1,203 @@
1
+ Copyright 2023-2026 AIRT Technologies Ltd.
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
@@ -0,0 +1,31 @@
1
+ # NOTICE
2
+
3
+ mononet
4
+ Copyright 2023-2026 AIRT Technologies Ltd.
5
+
6
+ This product is licensed under the Apache License, Version 2.0 (see
7
+ `LICENSE`).
8
+
9
+ ## Patent
10
+
11
+ This software implements technology described in U.S. Patent No.
12
+ 11,551,063 ("Implementing monotonic constrained neural networks",
13
+ assignee: AIRT Technologies Ltd.,
14
+ <https://patents.justia.com/patent/11551063>).
15
+
16
+ The software is distributed under the Apache License 2.0. Section 3 of
17
+ that license grants you the patent rights needed to use, make, and
18
+ distribute this software and your derivative works of it.
19
+
20
+ ## Reference paper
21
+
22
+ Runje, D., Shankaranarayana, S. M. (2023). *Constrained Monotonic Neural
23
+ Networks.* ICML 2023. <https://arxiv.org/abs/2205.11775>
24
+
25
+ If you use `mononet` in academic work, please cite this paper.
26
+
27
+ ## Trademarks
28
+
29
+ PyTorch is a trademark of the Linux Foundation. JAX is a trademark of
30
+ Google LLC. Keras is a trademark of Google LLC. Use of these trademark
31
+ names here indicates compatibility, not endorsement.
@@ -0,0 +1,118 @@
1
+ Metadata-Version: 2.4
2
+ Name: mononet
3
+ Version: 0.0.0a0
4
+ Summary: Unconstrained monotonic neural networks for PyTorch, JAX, and Keras
5
+ Project-URL: Homepage, https://github.com/davorrunje/mononet
6
+ Project-URL: Documentation, https://davorrunje.github.io/mononet
7
+ Project-URL: Repository, https://github.com/davorrunje/mononet
8
+ Project-URL: Issues, https://github.com/davorrunje/mononet/issues
9
+ Project-URL: Changelog, https://github.com/davorrunje/mononet/blob/main/CHANGELOG.md
10
+ Project-URL: Paper, https://arxiv.org/abs/2205.11775
11
+ Author-email: Davor Runje <davor.runje@fer.hr>
12
+ Maintainer-email: Davor Runje <davor.runje@fer.hr>
13
+ License-Expression: Apache-2.0
14
+ License-File: LICENSE
15
+ License-File: NOTICE.md
16
+ Keywords: deep-learning,jax,keras,monotonic,neural-network,pytorch
17
+ Classifier: Development Status :: 3 - Alpha
18
+ Classifier: Intended Audience :: Science/Research
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: <3.14,>=3.11
25
+ Requires-Dist: numpy>=1.26
26
+ Requires-Dist: typing-extensions>=4.12; python_version < '3.12'
27
+ Provides-Extra: all
28
+ Requires-Dist: flax>=0.10; extra == 'all'
29
+ Requires-Dist: jax>=0.4.30; extra == 'all'
30
+ Requires-Dist: keras>=3.5; extra == 'all'
31
+ Requires-Dist: torch>=2.4; extra == 'all'
32
+ Provides-Extra: jax
33
+ Requires-Dist: flax>=0.10; extra == 'jax'
34
+ Requires-Dist: jax>=0.4.30; extra == 'jax'
35
+ Provides-Extra: jax-gpu
36
+ Requires-Dist: flax>=0.10; extra == 'jax-gpu'
37
+ Requires-Dist: jax[cuda12]>=0.4.30; extra == 'jax-gpu'
38
+ Provides-Extra: keras
39
+ Requires-Dist: jax>=0.4.30; extra == 'keras'
40
+ Requires-Dist: keras>=3.5; extra == 'keras'
41
+ Provides-Extra: keras-gpu
42
+ Requires-Dist: jax[cuda12]>=0.4.30; extra == 'keras-gpu'
43
+ Requires-Dist: keras>=3.5; extra == 'keras-gpu'
44
+ Provides-Extra: torch
45
+ Requires-Dist: torch>=2.4; extra == 'torch'
46
+ Provides-Extra: torch-gpu
47
+ Requires-Dist: torch>=2.4; extra == 'torch-gpu'
48
+ Description-Content-Type: text/markdown
49
+
50
+ # mononet — Unconstrained Monotonic Neural Networks
51
+
52
+ [![PyPI version](https://img.shields.io/pypi/v/mononet)](https://pypi.org/project/mononet/)
53
+ [![Python versions](https://img.shields.io/pypi/pyversions/mononet)](https://pypi.org/project/mononet/)
54
+ [![Docs](https://img.shields.io/badge/docs-mononet-blue)](https://davorrunje.github.io/mononet/)
55
+ [![Build](https://github.com/davorrunje/mononet/actions/workflows/build.yml/badge.svg)](https://github.com/davorrunje/mononet/actions/workflows/build.yml)
56
+
57
+ Reference implementation of the unconstrained monotonic neural network
58
+ construction from:
59
+
60
+ > Runje, D., Shankaranarayana, S. M. (2023). *Constrained Monotonic
61
+ > Neural Networks.* ICML 2023. <https://arxiv.org/abs/2205.11775>
62
+
63
+ First-class support for **PyTorch**, **JAX** (Flax NNX), and **Keras 3**.
64
+
65
+ ## Install
66
+
67
+ pip install "mononet[torch]" # PyTorch
68
+ pip install "mononet[jax]" # JAX + Flax NNX
69
+ pip install "mononet[keras]" # Keras 3
70
+ pip install "mononet[all]" # all three
71
+
72
+ ## Quick start
73
+
74
+ A 60-second tour will appear here once the algorithm implementation lands.
75
+ Each backend exposes the same composed model (`MonoMLP`) and the
76
+ framework-idiomatic layer name (`MonoLinear` for PyTorch and JAX,
77
+ `MonoDense` for Keras).
78
+
79
+ ```python
80
+ # PyTorch
81
+ from mononet.torch import MonoMLP
82
+
83
+ # JAX
84
+ from mononet.jax import MonoMLP
85
+
86
+ # Keras 3
87
+ from mononet.keras import MonoMLP
88
+ ```
89
+
90
+ ## License
91
+
92
+ Apache License 2.0 — see [`LICENSE`](LICENSE) and [`NOTICE.md`](NOTICE.md).
93
+ Commercial use is permitted. The technique is described in U.S. Patent
94
+ 11,551,063 (assignee: AIRT Technologies Ltd.); the Apache-2.0 license
95
+ grants the patent rights needed to use this code. For academic use, please
96
+ cite the paper (see [`NOTICE.md`](NOTICE.md)).
97
+
98
+ ## Formal proofs
99
+
100
+ Every theorem in the paper is mechanized in Lean 4 + mathlib4 under
101
+ [`proofs/`](proofs/). See
102
+ [the cross-reference page](https://davorrunje.github.io/mononet/concepts/proofs.html)
103
+ for the paper-claim ↔ Lean-theorem ↔ Python-test mapping.
104
+
105
+ ## Documentation
106
+
107
+ Full docs at <https://davorrunje.github.io/mononet/>. Source for guides
108
+ and benchmarks lives in [`docs/docs/`](docs/docs/).
109
+
110
+ ## Contributing
111
+
112
+ See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the development workflow:
113
+ devcontainer choice, `uv sync`, pre-commit, per-backend test commands.
114
+
115
+ ## Citation
116
+
117
+ If you use `mononet` in academic work, please cite the paper. BibTeX is
118
+ in [`docs/docs/about/citation.md`](docs/docs/about/citation.md).
@@ -0,0 +1,69 @@
1
+ # mononet — Unconstrained Monotonic Neural Networks
2
+
3
+ [![PyPI version](https://img.shields.io/pypi/v/mononet)](https://pypi.org/project/mononet/)
4
+ [![Python versions](https://img.shields.io/pypi/pyversions/mononet)](https://pypi.org/project/mononet/)
5
+ [![Docs](https://img.shields.io/badge/docs-mononet-blue)](https://davorrunje.github.io/mononet/)
6
+ [![Build](https://github.com/davorrunje/mononet/actions/workflows/build.yml/badge.svg)](https://github.com/davorrunje/mononet/actions/workflows/build.yml)
7
+
8
+ Reference implementation of the unconstrained monotonic neural network
9
+ construction from:
10
+
11
+ > Runje, D., Shankaranarayana, S. M. (2023). *Constrained Monotonic
12
+ > Neural Networks.* ICML 2023. <https://arxiv.org/abs/2205.11775>
13
+
14
+ First-class support for **PyTorch**, **JAX** (Flax NNX), and **Keras 3**.
15
+
16
+ ## Install
17
+
18
+ pip install "mononet[torch]" # PyTorch
19
+ pip install "mononet[jax]" # JAX + Flax NNX
20
+ pip install "mononet[keras]" # Keras 3
21
+ pip install "mononet[all]" # all three
22
+
23
+ ## Quick start
24
+
25
+ A 60-second tour will appear here once the algorithm implementation lands.
26
+ Each backend exposes the same composed model (`MonoMLP`) and the
27
+ framework-idiomatic layer name (`MonoLinear` for PyTorch and JAX,
28
+ `MonoDense` for Keras).
29
+
30
+ ```python
31
+ # PyTorch
32
+ from mononet.torch import MonoMLP
33
+
34
+ # JAX
35
+ from mononet.jax import MonoMLP
36
+
37
+ # Keras 3
38
+ from mononet.keras import MonoMLP
39
+ ```
40
+
41
+ ## License
42
+
43
+ Apache License 2.0 — see [`LICENSE`](LICENSE) and [`NOTICE.md`](NOTICE.md).
44
+ Commercial use is permitted. The technique is described in U.S. Patent
45
+ 11,551,063 (assignee: AIRT Technologies Ltd.); the Apache-2.0 license
46
+ grants the patent rights needed to use this code. For academic use, please
47
+ cite the paper (see [`NOTICE.md`](NOTICE.md)).
48
+
49
+ ## Formal proofs
50
+
51
+ Every theorem in the paper is mechanized in Lean 4 + mathlib4 under
52
+ [`proofs/`](proofs/). See
53
+ [the cross-reference page](https://davorrunje.github.io/mononet/concepts/proofs.html)
54
+ for the paper-claim ↔ Lean-theorem ↔ Python-test mapping.
55
+
56
+ ## Documentation
57
+
58
+ Full docs at <https://davorrunje.github.io/mononet/>. Source for guides
59
+ and benchmarks lives in [`docs/docs/`](docs/docs/).
60
+
61
+ ## Contributing
62
+
63
+ See [`CONTRIBUTING.md`](CONTRIBUTING.md) for the development workflow:
64
+ devcontainer choice, `uv sync`, pre-commit, per-backend test commands.
65
+
66
+ ## Citation
67
+
68
+ If you use `mononet` in academic work, please cite the paper. BibTeX is
69
+ in [`docs/docs/about/citation.md`](docs/docs/about/citation.md).
@@ -0,0 +1,18 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ """mononet — Unconstrained monotonic neural networks.
3
+
4
+ Multi-backend support for PyTorch, JAX (Flax NNX), and Keras 3.
5
+ See https://arxiv.org/abs/2205.11775 for the reference paper.
6
+
7
+ Backends are imported lazily: `import mononet` does **not** import
8
+ torch / jax / keras. Use `from mononet.torch import ...` (or the
9
+ equivalent for jax/keras) to access backend layers.
10
+ """
11
+
12
+ from importlib.metadata import version
13
+
14
+ from mononet.core.types import MonotonicityMask
15
+
16
+ __version__ = version("mononet")
17
+
18
+ __all__ = ["MonotonicityMask", "__version__"]
@@ -0,0 +1,13 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ """Framework-agnostic primitives shared by all backends."""
3
+
4
+ from mononet.core.config import MonoConfig, MonoResidualConfig
5
+ from mononet.core.types import ActivationSpec, InitSpec, MonotonicityMask
6
+
7
+ __all__ = [
8
+ "ActivationSpec",
9
+ "InitSpec",
10
+ "MonoConfig",
11
+ "MonoResidualConfig",
12
+ "MonotonicityMask",
13
+ ]