icdn 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 (38) hide show
  1. icdn-0.1.0/LICENSE +201 -0
  2. icdn-0.1.0/PKG-INFO +325 -0
  3. icdn-0.1.0/README.md +95 -0
  4. icdn-0.1.0/pyproject.toml +53 -0
  5. icdn-0.1.0/setup.cfg +4 -0
  6. icdn-0.1.0/src/icdn/__init__.py +16 -0
  7. icdn-0.1.0/src/icdn/api.py +370 -0
  8. icdn-0.1.0/src/icdn/cli.py +65 -0
  9. icdn-0.1.0/src/icdn/config.py +144 -0
  10. icdn-0.1.0/src/icdn/data/__init__.py +16 -0
  11. icdn-0.1.0/src/icdn/data/dataset.py +100 -0
  12. icdn-0.1.0/src/icdn/data/encoders.py +56 -0
  13. icdn-0.1.0/src/icdn/data/features.py +205 -0
  14. icdn-0.1.0/src/icdn/data/panel.py +228 -0
  15. icdn-0.1.0/src/icdn/data/splits.py +92 -0
  16. icdn-0.1.0/src/icdn/model/__init__.py +21 -0
  17. icdn-0.1.0/src/icdn/model/context.py +99 -0
  18. icdn-0.1.0/src/icdn/model/demand.py +99 -0
  19. icdn-0.1.0/src/icdn/model/head.py +169 -0
  20. icdn-0.1.0/src/icdn/model/icdn.py +73 -0
  21. icdn-0.1.0/src/icdn/model/loss.py +156 -0
  22. icdn-0.1.0/src/icdn/model/neighbors.py +262 -0
  23. icdn-0.1.0/src/icdn/model/splines/__init__.py +4 -0
  24. icdn-0.1.0/src/icdn/model/splines/builder.py +60 -0
  25. icdn-0.1.0/src/icdn/model/splines/multi_cubic.py +75 -0
  26. icdn-0.1.0/src/icdn/training/__init__.py +19 -0
  27. icdn-0.1.0/src/icdn/training/checkpoints.py +49 -0
  28. icdn-0.1.0/src/icdn/training/metrics.py +80 -0
  29. icdn-0.1.0/src/icdn/training/trainer.py +276 -0
  30. icdn-0.1.0/src/icdn.egg-info/PKG-INFO +325 -0
  31. icdn-0.1.0/src/icdn.egg-info/SOURCES.txt +36 -0
  32. icdn-0.1.0/src/icdn.egg-info/dependency_links.txt +1 -0
  33. icdn-0.1.0/src/icdn.egg-info/entry_points.txt +2 -0
  34. icdn-0.1.0/src/icdn.egg-info/requires.txt +11 -0
  35. icdn-0.1.0/src/icdn.egg-info/top_level.txt +1 -0
  36. icdn-0.1.0/tests/test_api.py +73 -0
  37. icdn-0.1.0/tests/test_data.py +69 -0
  38. icdn-0.1.0/tests/test_model.py +99 -0
icdn-0.1.0/LICENSE ADDED
@@ -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 [yyyy] [name of copyright owner]
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.
icdn-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,325 @@
1
+ Metadata-Version: 2.4
2
+ Name: icdn
3
+ Version: 0.1.0
4
+ Summary: Demand and price elasticity estimation with integrable context-dependent demand networks
5
+ Author-email: Carlos Heredia <TU_EMAIL@ejemplo.com>
6
+ License: Apache License
7
+ Version 2.0, January 2004
8
+ http://www.apache.org/licenses/
9
+
10
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
11
+
12
+ 1. Definitions.
13
+
14
+ "License" shall mean the terms and conditions for use, reproduction,
15
+ and distribution as defined by Sections 1 through 9 of this document.
16
+
17
+ "Licensor" shall mean the copyright owner or entity authorized by
18
+ the copyright owner that is granting the License.
19
+
20
+ "Legal Entity" shall mean the union of the acting entity and all
21
+ other entities that control, are controlled by, or are under common
22
+ control with that entity. For the purposes of this definition,
23
+ "control" means (i) the power, direct or indirect, to cause the
24
+ direction or management of such entity, whether by contract or
25
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
26
+ outstanding shares, or (iii) beneficial ownership of such entity.
27
+
28
+ "You" (or "Your") shall mean an individual or Legal Entity
29
+ exercising permissions granted by this License.
30
+
31
+ "Source" form shall mean the preferred form for making modifications,
32
+ including but not limited to software source code, documentation
33
+ source, and configuration files.
34
+
35
+ "Object" form shall mean any form resulting from mechanical
36
+ transformation or translation of a Source form, including but
37
+ not limited to compiled object code, generated documentation,
38
+ and conversions to other media types.
39
+
40
+ "Work" shall mean the work of authorship, whether in Source or
41
+ Object form, made available under the License, as indicated by a
42
+ copyright notice that is included in or attached to the work
43
+ (an example is provided in the Appendix below).
44
+
45
+ "Derivative Works" shall mean any work, whether in Source or Object
46
+ form, that is based on (or derived from) the Work and for which the
47
+ editorial revisions, annotations, elaborations, or other modifications
48
+ represent, as a whole, an original work of authorship. For the purposes
49
+ of this License, Derivative Works shall not include works that remain
50
+ separable from, or merely link (or bind by name) to the interfaces of,
51
+ the Work and Derivative Works thereof.
52
+
53
+ "Contribution" shall mean any work of authorship, including
54
+ the original version of the Work and any modifications or additions
55
+ to that Work or Derivative Works thereof, that is intentionally
56
+ submitted to Licensor for inclusion in the Work by the copyright owner
57
+ or by an individual or Legal Entity authorized to submit on behalf of
58
+ the copyright owner. For the purposes of this definition, "submitted"
59
+ means any form of electronic, verbal, or written communication sent
60
+ to the Licensor or its representatives, including but not limited to
61
+ communication on electronic mailing lists, source code control systems,
62
+ and issue tracking systems that are managed by, or on behalf of, the
63
+ Licensor for the purpose of discussing and improving the Work, but
64
+ excluding communication that is conspicuously marked or otherwise
65
+ designated in writing by the copyright owner as "Not a Contribution."
66
+
67
+ "Contributor" shall mean Licensor and any individual or Legal Entity
68
+ on behalf of whom a Contribution has been received by Licensor and
69
+ subsequently incorporated within the Work.
70
+
71
+ 2. Grant of Copyright License. Subject to the terms and conditions of
72
+ this License, each Contributor hereby grants to You a perpetual,
73
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
74
+ copyright license to reproduce, prepare Derivative Works of,
75
+ publicly display, publicly perform, sublicense, and distribute the
76
+ Work and such Derivative Works in Source or Object form.
77
+
78
+ 3. Grant of Patent License. Subject to the terms and conditions of
79
+ this License, each Contributor hereby grants to You a perpetual,
80
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
81
+ (except as stated in this section) patent license to make, have made,
82
+ use, offer to sell, sell, import, and otherwise transfer the Work,
83
+ where such license applies only to those patent claims licensable
84
+ by such Contributor that are necessarily infringed by their
85
+ Contribution(s) alone or by combination of their Contribution(s)
86
+ with the Work to which such Contribution(s) was submitted. If You
87
+ institute patent litigation against any entity (including a
88
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
89
+ or a Contribution incorporated within the Work constitutes direct
90
+ or contributory patent infringement, then any patent licenses
91
+ granted to You under this License for that Work shall terminate
92
+ as of the date such litigation is filed.
93
+
94
+ 4. Redistribution. You may reproduce and distribute copies of the
95
+ Work or Derivative Works thereof in any medium, with or without
96
+ modifications, and in Source or Object form, provided that You
97
+ meet the following conditions:
98
+
99
+ (a) You must give any other recipients of the Work or
100
+ Derivative Works a copy of this License; and
101
+
102
+ (b) You must cause any modified files to carry prominent notices
103
+ stating that You changed the files; and
104
+
105
+ (c) You must retain, in the Source form of any Derivative Works
106
+ that You distribute, all copyright, patent, trademark, and
107
+ attribution notices from the Source form of the Work,
108
+ excluding those notices that do not pertain to any part of
109
+ the Derivative Works; and
110
+
111
+ (d) If the Work includes a "NOTICE" text file as part of its
112
+ distribution, then any Derivative Works that You distribute must
113
+ include a readable copy of the attribution notices contained
114
+ within such NOTICE file, excluding those notices that do not
115
+ pertain to any part of the Derivative Works, in at least one
116
+ of the following places: within a NOTICE text file distributed
117
+ as part of the Derivative Works; within the Source form or
118
+ documentation, if provided along with the Derivative Works; or,
119
+ within a display generated by the Derivative Works, if and
120
+ wherever such third-party notices normally appear. The contents
121
+ of the NOTICE file are for informational purposes only and
122
+ do not modify the License. You may add Your own attribution
123
+ notices within Derivative Works that You distribute, alongside
124
+ or as an addendum to the NOTICE text from the Work, provided
125
+ that such additional attribution notices cannot be construed
126
+ as modifying the License.
127
+
128
+ You may add Your own copyright statement to Your modifications and
129
+ may provide additional or different license terms and conditions
130
+ for use, reproduction, or distribution of Your modifications, or
131
+ for any such Derivative Works as a whole, provided Your use,
132
+ reproduction, and distribution of the Work otherwise complies with
133
+ the conditions stated in this License.
134
+
135
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
136
+ any Contribution intentionally submitted for inclusion in the Work
137
+ by You to the Licensor shall be under the terms and conditions of
138
+ this License, without any additional terms or conditions.
139
+ Notwithstanding the above, nothing herein shall supersede or modify
140
+ the terms of any separate license agreement you may have executed
141
+ with Licensor regarding such Contributions.
142
+
143
+ 6. Trademarks. This License does not grant permission to use the trade
144
+ names, trademarks, service marks, or product names of the Licensor,
145
+ except as required for reasonable and customary use in describing the
146
+ origin of the Work and reproducing the content of the NOTICE file.
147
+
148
+ 7. Disclaimer of Warranty. Unless required by applicable law or
149
+ agreed to in writing, Licensor provides the Work (and each
150
+ Contributor provides its Contributions) on an "AS IS" BASIS,
151
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
152
+ implied, including, without limitation, any warranties or conditions
153
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
154
+ PARTICULAR PURPOSE. You are solely responsible for determining the
155
+ appropriateness of using or redistributing the Work and assume any
156
+ risks associated with Your exercise of permissions under this License.
157
+
158
+ 8. Limitation of Liability. In no event and under no legal theory,
159
+ whether in tort (including negligence), contract, or otherwise,
160
+ unless required by applicable law (such as deliberate and grossly
161
+ negligent acts) or agreed to in writing, shall any Contributor be
162
+ liable to You for damages, including any direct, indirect, special,
163
+ incidental, or consequential damages of any character arising as a
164
+ result of this License or out of the use or inability to use the
165
+ Work (including but not limited to damages for loss of goodwill,
166
+ work stoppage, computer failure or malfunction, or any and all
167
+ other commercial damages or losses), even if such Contributor
168
+ has been advised of the possibility of such damages.
169
+
170
+ 9. Accepting Warranty or Additional Liability. While redistributing
171
+ the Work or Derivative Works thereof, You may choose to offer,
172
+ and charge a fee for, acceptance of support, warranty, indemnity,
173
+ or other liability obligations and/or rights consistent with this
174
+ License. However, in accepting such obligations, You may act only
175
+ on Your own behalf and on Your sole responsibility, not on behalf
176
+ of any other Contributor, and only if You agree to indemnify,
177
+ defend, and hold each Contributor harmless for any liability
178
+ incurred by, or claims asserted against, such Contributor by reason
179
+ of your accepting any such warranty or additional liability.
180
+
181
+ END OF TERMS AND CONDITIONS
182
+
183
+ APPENDIX: How to apply the Apache License to your work.
184
+
185
+ To apply the Apache License to your work, attach the following
186
+ boilerplate notice, with the fields enclosed by brackets "[]"
187
+ replaced with your own identifying information. (Don't include
188
+ the brackets!) The text should be enclosed in the appropriate
189
+ comment syntax for the file format. We also recommend that a
190
+ file or class name and description of purpose be included on the
191
+ same "printed page" as the copyright notice for easier
192
+ identification within third-party archives.
193
+
194
+ Copyright [yyyy] [name of copyright owner]
195
+
196
+ Licensed under the Apache License, Version 2.0 (the "License");
197
+ you may not use this file except in compliance with the License.
198
+ You may obtain a copy of the License at
199
+
200
+ http://www.apache.org/licenses/LICENSE-2.0
201
+
202
+ Unless required by applicable law or agreed to in writing, software
203
+ distributed under the License is distributed on an "AS IS" BASIS,
204
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
205
+ See the License for the specific language governing permissions and
206
+ limitations under the License.
207
+
208
+ Project-URL: Homepage, https://github.com/carlosherediapimienta/ICDN
209
+ Project-URL: Repository, https://github.com/carlosherediapimienta/ICDN
210
+ Project-URL: Issues, https://github.com/carlosherediapimienta/ICDN/issues
211
+ Keywords: elasticity,demand,pricing,deep-learning
212
+ Classifier: Development Status :: 3 - Alpha
213
+ Classifier: Intended Audience :: Science/Research
214
+ Classifier: License :: OSI Approved :: Apache Software License
215
+ Classifier: Programming Language :: Python :: 3
216
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
217
+ Requires-Python: >=3.10
218
+ Description-Content-Type: text/markdown
219
+ License-File: LICENSE
220
+ Requires-Dist: numpy>=1.24
221
+ Requires-Dist: pandas>=2.0
222
+ Requires-Dist: torch>=2.0
223
+ Requires-Dist: pyyaml>=6.0
224
+ Provides-Extra: dev
225
+ Requires-Dist: pytest>=7.4; extra == "dev"
226
+ Requires-Dist: ruff>=0.4; extra == "dev"
227
+ Provides-Extra: parquet
228
+ Requires-Dist: pyarrow>=14.0; extra == "parquet"
229
+ Dynamic: license-file
230
+
231
+ # ICDN
232
+
233
+ Demand and price-elasticity estimation for retail panels, powered by an
234
+ Integrable Context-Dependent Demand Network.
235
+
236
+ The model fits a single smooth log-demand surface conditioned on store,
237
+ calendar, promotional and competitive context, and reads own- and cross-price
238
+ elasticities off its derivatives. Prediction and elasticity estimation
239
+ therefore come from the same fitted object instead of separate regressions.
240
+
241
+ ## Install
242
+
243
+ ```bash
244
+ pip install icdn
245
+ ```
246
+
247
+ ## Quickstart
248
+
249
+ Your panel needs one row per store, product and period:
250
+
251
+ | store_code | product_code | week_id | price | units | on_promo |
252
+ |---|---|---|---|---|---|
253
+ | S1 | P1 | 1 | 2.49 | 130 | 0 |
254
+ | S1 | P2 | 1 | 3.10 | 88 | 1 |
255
+
256
+ ```python
257
+ import pandas as pd
258
+ from icdn import ICDNModel, ICDNConfig
259
+
260
+ panel = pd.read_parquet("panel.parquet")
261
+
262
+ model = ICDNModel(ICDNConfig(n_products=5))
263
+ model.fit(panel)
264
+
265
+ elasticities = model.elasticities()
266
+ predictions = model.predict(panel)
267
+ model.save("artifacts/icdn")
268
+ ```
269
+
270
+ `elasticities()` returns one row per store and product pair:
271
+
272
+ | store_code | product | competitor | kind | elasticity | ci_low | ci_high |
273
+ |---|---|---|---|---|---|---|
274
+ | S1 | P1 | P1 | own | -2.14 | -2.42 | -1.88 |
275
+ | S1 | P1 | P2 | cross | 0.37 | 0.19 | 0.55 |
276
+
277
+ Lags, seasonality, promotional pressure and competitive context are engineered
278
+ internally, so nothing beyond the six columns above is required.
279
+
280
+ ## Mapping your columns
281
+
282
+ If your column names differ, describe them once:
283
+
284
+ ```python
285
+ from icdn import ICDNConfig, PanelSchema
286
+
287
+ config = ICDNConfig(
288
+ schema=PanelSchema(
289
+ store="shop_id",
290
+ product="sku",
291
+ period="week",
292
+ price="avg_price",
293
+ units="qty",
294
+ promo="promo_flag",
295
+ category="category", # optional, restricts who competes with whom
296
+ brand="brand", # optional, biases competitor selection
297
+ ),
298
+ n_products=10,
299
+ )
300
+ ```
301
+
302
+ ## Command line
303
+
304
+ ```bash
305
+ icdn fit --data panel.parquet --config configs/default.yaml --out artifacts/model.icdn
306
+ icdn predict --model artifacts/model.icdn --data panel.parquet --out predictions.csv
307
+ icdn elasticities --model artifacts/model.icdn --data panel.parquet --out elasticities.csv
308
+ ```
309
+
310
+ ## Documentation
311
+
312
+ - [Getting started](docs/getting-started.md) covers the data contract, the
313
+ configuration reference and how training works.
314
+
315
+ ## Development
316
+
317
+ ```bash
318
+ pip install -e ".[dev]"
319
+ pytest
320
+ ruff check .
321
+ ```
322
+
323
+ ## License
324
+
325
+ See [LICENSE](LICENSE).
icdn-0.1.0/README.md ADDED
@@ -0,0 +1,95 @@
1
+ # ICDN
2
+
3
+ Demand and price-elasticity estimation for retail panels, powered by an
4
+ Integrable Context-Dependent Demand Network.
5
+
6
+ The model fits a single smooth log-demand surface conditioned on store,
7
+ calendar, promotional and competitive context, and reads own- and cross-price
8
+ elasticities off its derivatives. Prediction and elasticity estimation
9
+ therefore come from the same fitted object instead of separate regressions.
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ pip install icdn
15
+ ```
16
+
17
+ ## Quickstart
18
+
19
+ Your panel needs one row per store, product and period:
20
+
21
+ | store_code | product_code | week_id | price | units | on_promo |
22
+ |---|---|---|---|---|---|
23
+ | S1 | P1 | 1 | 2.49 | 130 | 0 |
24
+ | S1 | P2 | 1 | 3.10 | 88 | 1 |
25
+
26
+ ```python
27
+ import pandas as pd
28
+ from icdn import ICDNModel, ICDNConfig
29
+
30
+ panel = pd.read_parquet("panel.parquet")
31
+
32
+ model = ICDNModel(ICDNConfig(n_products=5))
33
+ model.fit(panel)
34
+
35
+ elasticities = model.elasticities()
36
+ predictions = model.predict(panel)
37
+ model.save("artifacts/icdn")
38
+ ```
39
+
40
+ `elasticities()` returns one row per store and product pair:
41
+
42
+ | store_code | product | competitor | kind | elasticity | ci_low | ci_high |
43
+ |---|---|---|---|---|---|---|
44
+ | S1 | P1 | P1 | own | -2.14 | -2.42 | -1.88 |
45
+ | S1 | P1 | P2 | cross | 0.37 | 0.19 | 0.55 |
46
+
47
+ Lags, seasonality, promotional pressure and competitive context are engineered
48
+ internally, so nothing beyond the six columns above is required.
49
+
50
+ ## Mapping your columns
51
+
52
+ If your column names differ, describe them once:
53
+
54
+ ```python
55
+ from icdn import ICDNConfig, PanelSchema
56
+
57
+ config = ICDNConfig(
58
+ schema=PanelSchema(
59
+ store="shop_id",
60
+ product="sku",
61
+ period="week",
62
+ price="avg_price",
63
+ units="qty",
64
+ promo="promo_flag",
65
+ category="category", # optional, restricts who competes with whom
66
+ brand="brand", # optional, biases competitor selection
67
+ ),
68
+ n_products=10,
69
+ )
70
+ ```
71
+
72
+ ## Command line
73
+
74
+ ```bash
75
+ icdn fit --data panel.parquet --config configs/default.yaml --out artifacts/model.icdn
76
+ icdn predict --model artifacts/model.icdn --data panel.parquet --out predictions.csv
77
+ icdn elasticities --model artifacts/model.icdn --data panel.parquet --out elasticities.csv
78
+ ```
79
+
80
+ ## Documentation
81
+
82
+ - [Getting started](docs/getting-started.md) covers the data contract, the
83
+ configuration reference and how training works.
84
+
85
+ ## Development
86
+
87
+ ```bash
88
+ pip install -e ".[dev]"
89
+ pytest
90
+ ruff check .
91
+ ```
92
+
93
+ ## License
94
+
95
+ See [LICENSE](LICENSE).
@@ -0,0 +1,53 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "icdn"
7
+ version = "0.1.0"
8
+ description = "Demand and price elasticity estimation with integrable context-dependent demand networks"
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ license = { file = "LICENSE" }
12
+ authors = [
13
+ { name = "Carlos Heredia", email = "TU_EMAIL@ejemplo.com" },
14
+ ]
15
+ keywords = ["elasticity", "demand", "pricing", "deep-learning"]
16
+ classifiers = [
17
+ "Development Status :: 3 - Alpha",
18
+ "Intended Audience :: Science/Research",
19
+ "License :: OSI Approved :: Apache Software License",
20
+ "Programming Language :: Python :: 3",
21
+ "Topic :: Scientific/Engineering :: Artificial Intelligence",
22
+ ]
23
+ dependencies = [
24
+ "numpy>=1.24",
25
+ "pandas>=2.0",
26
+ "torch>=2.0",
27
+ "pyyaml>=6.0",
28
+ ]
29
+
30
+ [project.urls]
31
+ Homepage = "https://github.com/carlosherediapimienta/ICDN"
32
+ Repository = "https://github.com/carlosherediapimienta/ICDN"
33
+ Issues = "https://github.com/carlosherediapimienta/ICDN/issues"
34
+
35
+ [project.optional-dependencies]
36
+ dev = ["pytest>=7.4", "ruff>=0.4"]
37
+ parquet = ["pyarrow>=14.0"]
38
+
39
+ [project.scripts]
40
+ icdn = "icdn.cli:main"
41
+
42
+ [tool.setuptools.packages.find]
43
+ where = ["src"]
44
+
45
+ [tool.ruff]
46
+ line-length = 100
47
+ src = ["src", "tests"]
48
+
49
+ [tool.ruff.lint]
50
+ select = ["E", "F", "I", "UP", "B"]
51
+
52
+ [tool.pytest.ini_options]
53
+ testpaths = ["tests"]
icdn-0.1.0/setup.cfg ADDED
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+