relationalai-predictive 1.0.0__py3-none-any.whl

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. relationalai_predictive/CHANGELOG.md +159 -0
  2. relationalai_predictive/LICENCE +202 -0
  3. relationalai_predictive/README.md +816 -0
  4. relationalai_predictive/__init__.py +73 -0
  5. relationalai_predictive/_version.py +24 -0
  6. relationalai_predictive/common/__init__.py +0 -0
  7. relationalai_predictive/common/constants.py +2 -0
  8. relationalai_predictive/common/dataset_model.py +699 -0
  9. relationalai_predictive/common/dfs_schema_checker.py +295 -0
  10. relationalai_predictive/common/exceptions.py +87 -0
  11. relationalai_predictive/common/export.py +58 -0
  12. relationalai_predictive/common/job_models.py +265 -0
  13. relationalai_predictive/core/__init__.py +0 -0
  14. relationalai_predictive/core/gnn/__init__.py +0 -0
  15. relationalai_predictive/core/gnn/gnn_config.py +289 -0
  16. relationalai_predictive/core/gnn/gnn_estimator.py +838 -0
  17. relationalai_predictive/core/icl/__init__.py +0 -0
  18. relationalai_predictive/core/icl/icl_config.py +136 -0
  19. relationalai_predictive/core/icl/icl_estimator.py +400 -0
  20. relationalai_predictive/core/shared/__init__.py +0 -0
  21. relationalai_predictive/core/shared/api_request_handler.py +107 -0
  22. relationalai_predictive/core/shared/connector.py +316 -0
  23. relationalai_predictive/core/shared/dataset.py +570 -0
  24. relationalai_predictive/core/shared/db_diagram.py +223 -0
  25. relationalai_predictive/core/shared/diagnostics.py +236 -0
  26. relationalai_predictive/core/shared/estimator_base.py +267 -0
  27. relationalai_predictive/core/shared/experiment_config.py +18 -0
  28. relationalai_predictive/core/shared/job_manager.py +553 -0
  29. relationalai_predictive/core/shared/model_manager.py +189 -0
  30. relationalai_predictive/core/shared/provider.py +370 -0
  31. relationalai_predictive/core/shared/relational_table.py +698 -0
  32. relationalai_predictive/core/shared/relational_task.py +732 -0
  33. relationalai_predictive/core/shared/tabular_task.py +165 -0
  34. relationalai_predictive/core/shared/utils.py +534 -0
  35. relationalai_predictive/instructions_to_add_sdk_to_sf_notebooks.MD +81 -0
  36. relationalai_predictive-1.0.0.dist-info/METADATA +16 -0
  37. relationalai_predictive-1.0.0.dist-info/RECORD +38 -0
  38. relationalai_predictive-1.0.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,159 @@
1
+ # Changelog
2
+
3
+ ## Unreleased
4
+
5
+ ### Breaking Changes
6
+
7
+ - **Package renamed**: `relationalai_gnns` / `relationalai-gnns` is renamed to `relationalai_predictive` / `relationalai-predictive`, reflecting support for predictive estimators beyond GNN. Update `pip install relationalai-predictive` and `import relationalai_predictive` accordingly — there is no compatibility shim for the old name.
8
+
9
+ ## v0.3.0 - (07-02-2026)
10
+
11
+ ### Features
12
+
13
+ - **List registered models**: Added `ModelManager.list_registered_models(database_name, schema_name)` as a read counterpart to `register_model`. Returns all models registered in the given Snowflake database and schema as a list of dicts, with `versions` and `aliases` fields automatically parsed from JSON strings when returned by older Snowflake SDK versions.
14
+
15
+ - **Slim published package dependencies**: Removed `python-dotenv` and `pyyaml` from published dependencies — neither is used by `relationalai_gnns` directly. `pyyaml` is now explicitly declared in the `backend` and `test` dependency groups where it is actually needed.
16
+
17
+ - **Remove `sqlalchemy`, `pydot`, and `tabulate` dependencies**: `Dataset.visualize_dataset()` now returns a `DatasetDiagram` object instead of a `pydot.Dot` object. The diagram auto-renders as SVG in Jupyter when the cell result is evaluated, and exposes `.display()` for explicit rendering, `.save("schema.svg")` to write to a file, and `.source` / `str(diagram)` for the raw Graphviz DOT string — replacing the old `Image(graph.create_png())` pattern. Column listings printed by `GNNTable.show_table()` and `Task.show_task()` (`LinkTask`/`NodeTask`) are now rendered with a small stdlib-only grid formatter instead of `tabulate`, with equivalent output.
18
+
19
+ ## v0.2.2 - (06-09-2026)
20
+
21
+ ### Bug Fixes
22
+
23
+ - **Relax pandas minimum version**: Removed `pandas` as a published dependency and relaxed the minimum version constraint to `>=2.2.0`, unblocking clients on Python 3.10 pinned to older pandas releases (e.g. pandas 2.3.0) from installing the package.
24
+
25
+ ## v0.2.1 - (06-08-2026)
26
+
27
+ ### Bug Fixes
28
+
29
+ - **Retry `stream_logs` on transient errors**: `_stream_logs_is_native_app` and `_stream_logs_http_approach` now wrap each poll/request in a per-poll retry loop. On transient errors (503, timeout, connection reset) the call is retried in place — the `continuation_token` is never reset, so the stream does not restart from the beginning. `PermissionError` and `MemoryError` propagate immediately. `stream_logs()` exposes `num_retries` (default `3`) and `retry_delay` (default `1.0s`) so callers can tune the behaviour.
30
+
31
+
32
+ ## v0.2.0 - (05-27-2026)
33
+
34
+
35
+ ## v0.1.9 - (05-21-2026)
36
+
37
+ ### Features
38
+
39
+ - **Live training progress bar**: Added a client-side progress bar (powered by `tqdm`) that displays real-time epoch and batch-level updates while streaming training logs. The engine emits `TRAINING_PROGRESS:` signals from all three job types (node, link, repeated link); `JobManager` parses these signals and renders a single batch-level bar that advances in place — replayed log segments (on stream restart) are detected by wall-clock timing and suppressed so the bar never jumps backward.
40
+
41
+ ## v0.1.8 - (05-12-2026)
42
+
43
+
44
+ ## v0.1.7 - (05-04-2026)
45
+
46
+ ### Bug Fixes
47
+
48
+ - **Edge tables excluded from metadata-graph diameter**: Fixed `_build_metadata_graph` so that edge-typed `GNNTable`s are no longer counted as graph vertices when computing the metadata-graph diameter. Edge tables are now collapsed into a single direct undirected edge between the two node tables they bridge, matching what `graph_construction.graph._prepare_edges_using_edge_list` does in the real GNN graph. Previously the inflated diameter caused spurious `Trainer._warn_if_receptive_field_too_shallow` warnings for node prediction and false `ValueError`s for repeated link prediction on datasets that use edge tables.
49
+
50
+ - **Self-referential edge-table schemas no longer crash the receptive-field check**: `Trainer._warn_if_receptive_field_too_shallow` no longer trips on the `(diameter=0, farthest_pair=None)` return that smoking-style schemas produce (one node table with a self-referential edge table whose two FKs both point to that same node). `TrainerConfig` validation requires `len(fanouts) >= 1` and `gnn_layers >= 1`, and at `D = 0` every task's threshold is ≤ 1, so the check now returns silently via the early-return rather than falling through to message-building and unpacking `None`. Also renamed user-facing wording from "metadata graph diameter" to "schema diameter" so it is clear we are referring to the DB schema's FK structure.
51
+
52
+ ## v0.1.6 - (05-01-2026)
53
+
54
+ ### Features
55
+
56
+ - **Preflight Snowflake permission check for experiment tracking**: Added a preflight check in `Trainer` that verifies the Native App has the required Snowflake permissions before training starts. Attempts an authoritative grant-level check via `SHOW GRANTS ON DATABASE/SCHEMA`; if the current role lacks privilege, delegates to the Native App which uses a transient `CREATE EXPERIMENT` + `DROP` test. Returns a structured diagnostic result with six fields (`db_exists`, `schema_exists`, `usage_on_db`, `usage_on_schema`, `create_experiment`, `create_model`) and raises actionable errors with the exact `GRANT` statements needed to fix missing permissions.
57
+
58
+ - **Task-aware receptive-field check vs metadata graph diameter**: `Trainer` now computes the diameter `D` of the dataset's metadata (FK) graph and validates the configured `fanouts` depth against it. Repeated link prediction raises `ValueError` when `len(fanouts) < D - 1`; non-repeated link prediction warns below `ceil(D / 2)`; node tasks warn below `D`. The metadata graph is cached on `Dataset` after FK validation and reused for connectivity and diameter checks.
59
+
60
+
61
+ ## v0.1.5 - (04-17-2026)
62
+
63
+ ### Features
64
+
65
+ - **Unified engine job management**: Migrated internal SDK calls from the `experimental` to the `api` schema in the Native App (`cancel_job` and related operations), aligning with the stable engine API.
66
+
67
+ ### Bug Fixes
68
+
69
+ - **Secure views always created for Native App inference**: Fixed a regression introduced in v0.1.4 where making `output_config` optional caused secure views to be skipped during Native App inference. Views are now always created when running inference via a Native App, since the SDK reads results through `source_views`.
70
+
71
+ ---
72
+
73
+ ## v0.1.4 - (04-15-2026)
74
+
75
+ ### Features
76
+
77
+ - **GTable custom column types**: Added `column_dtypes` parameter to `GNNTable` to allow explicit dtype overrides for columns whose types cannot be inferred automatically. Accepts a mapping of column name to `ColumnDType` or string.
78
+
79
+ - **`output_config` optional in Trainer**: Made `output_config` an optional parameter in `Trainer`, simplifying instantiation when output configuration is not needed.
80
+
81
+ - **Token-expiry resilience for experiment tracking**: Added automatic retry logic when experiment tracking tokens expire during long-running training jobs.
82
+
83
+ ### Bug Fixes
84
+
85
+ - **Reduced memory footprint during graph construction**: DataFrames are now released eagerly after use during graph construction, reducing peak memory consumption for large graphs.
86
+
87
+ - **Object type detection for catalog-integration tables**: Fixed incorrect object type detection for Snowflake catalog-integration tables that caused schema mismatches.
88
+
89
+ ---
90
+
91
+ ## v0.1.3 - (04-01-2026)
92
+
93
+ ### Features
94
+
95
+ - **Overwrite results option for Snowflake table materialization**: Added `overwrite_results` parameter to `Trainer` to control whether existing Snowflake result tables are overwritten when materializing prediction outputs.
96
+
97
+ - **Training start logging and SQL diagnostics**: Training start events are now logged and Snowflake SQL library (sqlib) debug logs are captured, improving observability during training runs.
98
+
99
+ - **Model removal cleanup**: Improved model lifecycle management so all associated artifacts are fully cleaned up when a model version is deleted.
100
+
101
+ ### Bug Fixes
102
+
103
+ - **Engine readiness detection**: Fixed an issue where the engine was incorrectly detected as not ready, causing training jobs to fail prematurely.
104
+
105
+ - **Grace drain and queue cleanup for job monitoring**: Job monitoring now performs a graceful drain and queue cleanup on shutdown, preventing resource leaks when stopping long-running jobs.
106
+
107
+ ---
108
+
109
+ ## v0.1.2 - (03-11-2026)
110
+
111
+ ### Features
112
+
113
+ - **Diagnostics framework for job error handling**: Added a new `diagnostics` module with `PermissionDiagnostic` and `LogPatternDiagnostic` classes that detect known error patterns during job monitoring (log streaming and status checks) and provide enhanced, actionable error messages.
114
+
115
+ - **Database/Schema permission error detection**: Automatically detect Snowflake database and schema permission errors and raise `PermissionError` with detailed SQL grant instructions including the configured database/schema names.
116
+
117
+ - **Out-of-memory error detection**: Detect OOM errors (process exit code -9) during training and raise `MemoryError` with a recommendation to use a larger instance.
118
+
119
+ ---
120
+
121
+ ## v0.1.1 - (02-23-2026)
122
+
123
+ ### Features
124
+
125
+ - **Skip table reference validation for non-Snowflake connectors**: Allow Snowflake connectors that read CSVs and not only tables by skipping table reference validation for non-Snowflake connector types.
126
+
127
+ ---
128
+
129
+ ## v0.1.0 - (02-11-2026)
130
+
131
+ ### Features
132
+
133
+ - **Simplified model operations**: Removed `experiment_name` parameter from `delete_model()`, `register_model()`, and `predict()`. Experiment name is now automatically resolved from `model_run_id`.
134
+
135
+ - **Schema and dtype validation**: Added validation in `predict()` to ensure inference datasets match training dataset structure. New `align_dtypes` parameter automatically aligns data types when set to `True`.
136
+
137
+ - **Enhanced prediction logic**: Improved `predict()` method with better validation and support for three inference scenarios: using training dataset, custom test table, or new dataset.
138
+
139
+ - **Foreign key sorting**: Added automatic sorting of foreign keys in `TableSchema` for consistent schema ordering.
140
+
141
+ - **File locking**: Implemented thread-safe file locking for model registry and mapping file operations to prevent race conditions.
142
+
143
+ ### Documentation
144
+
145
+ - Updated directory structure documentation in `config.py` for better clarity.
146
+
147
+ ---
148
+
149
+ ## v0.0.4 - (01-26-2026)
150
+
151
+ ---
152
+
153
+ ## v0.0.3 - (01-21-2026)
154
+
155
+ ---
156
+
157
+ ## v0.0.1 - (01-13-2026)
158
+
159
+ - First release of `GNN SDK`
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright 2025 relationalAI
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.