redcedar 0.93.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.
@@ -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.
@@ -0,0 +1,89 @@
1
+ Metadata-Version: 2.1
2
+ Name: redcedar
3
+ Version: 0.93.0
4
+ Summary: Python client for the Red Cedar quantum machine learning server
5
+ Author: Cascade Quantum
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/coherent-computing/redcedar
8
+ Project-URL: Documentation, https://coherent-computing.github.io/redcedar/
9
+ Keywords: quantum computing,quantum machine learning,machine learning,explainable ai,client,sdk
10
+ Requires-Python: >=3.9
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Requires-Dist: requests>=2.28
14
+ Provides-Extra: plotting
15
+ Requires-Dist: matplotlib>=3.5; extra == "plotting"
16
+
17
+ # redcedar
18
+
19
+ Python client for the Red Cedar quantum machine learning server. Train quantum models on your own data, test them, make predictions and see which features drive them, from a notebook, a script or the command line. The circuits run on the server, so no quantum computing libraries are needed on your machine.
20
+
21
+ ## Install
22
+
23
+ ```bash
24
+ pip install redcedar
25
+ ```
26
+
27
+ The only dependency is `requests`. The example notebooks also plot with matplotlib: `pip install "redcedar[plotting]"`.
28
+
29
+ ## Quick Example
30
+
31
+ ```python
32
+ import redcedar
33
+
34
+ client = redcedar.connect(url="https://<server-url>", api_key="your-api-key")
35
+ print(client.status()) # {'ok': True, 'server_version': '0.93', 'sdk_version': '0.93.0'}
36
+
37
+ # Train on a CSV file (last column = class label) or a catalog dataset
38
+ result = client.training.run("my_data.csv", verbose=True, settings={"num_qubits": 4, "max_layers": 2})
39
+ train_id = result['train_id']
40
+
41
+ # Test on the rows held back from training
42
+ report = client.training.evaluate(train_id)
43
+ print(f"Accuracy: {report['overall_accuracy']:.1%}")
44
+
45
+ # Predict new rows, and save them with the predictions
46
+ predictions = client.inference.run(train_id, "new_data.csv", output="predictions.csv")
47
+
48
+ # Which input features drive the model
49
+ explanation = client.explainable.run(train_id)
50
+ for q in explanation['qubit_map']:
51
+ print(f"{q['feature_name']}: {q['importance']*100:.1f}%")
52
+ ```
53
+
54
+ `REDCEDAR_URL` and `REDCEDAR_API_KEY` can be set in the environment instead, and then `redcedar.connect()` needs no arguments.
55
+
56
+ ## Features
57
+
58
+ - **Training** on your own CSV files or on datasets in the server's catalog, for classification and regression, with settings passed as a dict or a JSON or TOML file
59
+ - **Evaluation** on held-out test rows, with accuracy and loss overall and per class
60
+ - **Predictions** for each row of a new file, with class probabilities, written to a CSV file if you like
61
+ - **Explainable AI**: which input features the model relies on
62
+ - **Dataset analysis** before training: PCA, mutual information, and an estimate of the qubits a dataset needs
63
+ - **Simulators and quantum hardware**: the server runs the circuits on Qiskit and CUDA-Q simulators (including multi-GPU) and on IonQ and IQM simulators and quantum computers
64
+ - **Progress reporting** for long jobs, which wait in the server's queue when it's busy
65
+ - **Command line**: `redcedar train`, `evaluate`, `predict`, `models` and `status`, without writing any Python
66
+
67
+ ## Getting Access
68
+
69
+ The client connects to a Red Cedar server. A hosted server accepts only requests with a valid API key: contact your Cascade Quantum representative to get one. If you have access to the Red Cedar user interface, you can create your own key there, under **API Keys**.
70
+
71
+ ## Documentation
72
+
73
+ - **[Quick Start](https://coherent-computing.github.io/redcedar/quick_start/)**: install, connect, train a model and make predictions
74
+ - **[User Guide](https://coherent-computing.github.io/redcedar/user_guide/)**: every call and setting, the command line, and the current limitations
75
+ - **[Full Documentation](https://coherent-computing.github.io/redcedar/)**: also examples, release notes and known issues
76
+
77
+ ## Source
78
+
79
+ [github.com/coherent-computing/redcedar](https://github.com/coherent-computing/redcedar). To install from a clone:
80
+
81
+ ```bash
82
+ git clone https://github.com/coherent-computing/redcedar.git
83
+ cd redcedar
84
+ pip install -e .
85
+ ```
86
+
87
+ ## License
88
+
89
+ See [LICENSE](https://github.com/coherent-computing/redcedar/blob/main/LICENSE).
@@ -0,0 +1,73 @@
1
+ # redcedar
2
+
3
+ Python client for the Red Cedar quantum machine learning server. Train quantum models on your own data, test them, make predictions and see which features drive them, from a notebook, a script or the command line. The circuits run on the server, so no quantum computing libraries are needed on your machine.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ pip install redcedar
9
+ ```
10
+
11
+ The only dependency is `requests`. The example notebooks also plot with matplotlib: `pip install "redcedar[plotting]"`.
12
+
13
+ ## Quick Example
14
+
15
+ ```python
16
+ import redcedar
17
+
18
+ client = redcedar.connect(url="https://<server-url>", api_key="your-api-key")
19
+ print(client.status()) # {'ok': True, 'server_version': '0.93', 'sdk_version': '0.93.0'}
20
+
21
+ # Train on a CSV file (last column = class label) or a catalog dataset
22
+ result = client.training.run("my_data.csv", verbose=True, settings={"num_qubits": 4, "max_layers": 2})
23
+ train_id = result['train_id']
24
+
25
+ # Test on the rows held back from training
26
+ report = client.training.evaluate(train_id)
27
+ print(f"Accuracy: {report['overall_accuracy']:.1%}")
28
+
29
+ # Predict new rows, and save them with the predictions
30
+ predictions = client.inference.run(train_id, "new_data.csv", output="predictions.csv")
31
+
32
+ # Which input features drive the model
33
+ explanation = client.explainable.run(train_id)
34
+ for q in explanation['qubit_map']:
35
+ print(f"{q['feature_name']}: {q['importance']*100:.1f}%")
36
+ ```
37
+
38
+ `REDCEDAR_URL` and `REDCEDAR_API_KEY` can be set in the environment instead, and then `redcedar.connect()` needs no arguments.
39
+
40
+ ## Features
41
+
42
+ - **Training** on your own CSV files or on datasets in the server's catalog, for classification and regression, with settings passed as a dict or a JSON or TOML file
43
+ - **Evaluation** on held-out test rows, with accuracy and loss overall and per class
44
+ - **Predictions** for each row of a new file, with class probabilities, written to a CSV file if you like
45
+ - **Explainable AI**: which input features the model relies on
46
+ - **Dataset analysis** before training: PCA, mutual information, and an estimate of the qubits a dataset needs
47
+ - **Simulators and quantum hardware**: the server runs the circuits on Qiskit and CUDA-Q simulators (including multi-GPU) and on IonQ and IQM simulators and quantum computers
48
+ - **Progress reporting** for long jobs, which wait in the server's queue when it's busy
49
+ - **Command line**: `redcedar train`, `evaluate`, `predict`, `models` and `status`, without writing any Python
50
+
51
+ ## Getting Access
52
+
53
+ The client connects to a Red Cedar server. A hosted server accepts only requests with a valid API key: contact your Cascade Quantum representative to get one. If you have access to the Red Cedar user interface, you can create your own key there, under **API Keys**.
54
+
55
+ ## Documentation
56
+
57
+ - **[Quick Start](https://coherent-computing.github.io/redcedar/quick_start/)**: install, connect, train a model and make predictions
58
+ - **[User Guide](https://coherent-computing.github.io/redcedar/user_guide/)**: every call and setting, the command line, and the current limitations
59
+ - **[Full Documentation](https://coherent-computing.github.io/redcedar/)**: also examples, release notes and known issues
60
+
61
+ ## Source
62
+
63
+ [github.com/coherent-computing/redcedar](https://github.com/coherent-computing/redcedar). To install from a clone:
64
+
65
+ ```bash
66
+ git clone https://github.com/coherent-computing/redcedar.git
67
+ cd redcedar
68
+ pip install -e .
69
+ ```
70
+
71
+ ## License
72
+
73
+ See [LICENSE](https://github.com/coherent-computing/redcedar/blob/main/LICENSE).
@@ -0,0 +1,30 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68.0"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "redcedar"
7
+ version = "0.93.0"
8
+ description = "Python client for the Red Cedar quantum machine learning server"
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = {text = "Apache-2.0"}
12
+ authors = [{name = "Cascade Quantum"}]
13
+ keywords = ["quantum computing", "quantum machine learning", "machine learning", "explainable ai", "client", "sdk"]
14
+
15
+ dependencies = [
16
+ "requests>=2.28",
17
+ ]
18
+
19
+ [project.urls]
20
+ Homepage = "https://github.com/coherent-computing/redcedar"
21
+ Documentation = "https://coherent-computing.github.io/redcedar/"
22
+
23
+ [project.scripts]
24
+ redcedar = "redcedar.cli:main"
25
+
26
+ [project.optional-dependencies]
27
+ plotting = ["matplotlib>=3.5"]
28
+
29
+ [tool.setuptools.packages.find]
30
+ include = ["redcedar*"]
@@ -0,0 +1,7 @@
1
+ """Red Cedar — Python client for the Red Cedar quantum ML server."""
2
+
3
+ __version__ = "0.93.0"
4
+
5
+ from .client import connect, RedCedarClient
6
+
7
+ __all__ = ["connect", "RedCedarClient", "__version__"]
@@ -0,0 +1,7 @@
1
+ """python -m redcedar — the same as the redcedar command."""
2
+
3
+ import sys
4
+
5
+ from .cli import main
6
+
7
+ sys.exit(main())
@@ -0,0 +1,74 @@
1
+ """Dataset analysis — PCA, Mutual Information, Resource Estimation."""
2
+
3
+
4
+ class AnalysisManager:
5
+ """Run dataset analysis operations on the server."""
6
+
7
+ def __init__(self, client):
8
+ self._client = client
9
+
10
+ def pca(self, dataset_id, verbose=False, on_progress=None):
11
+ """Run PCA analysis on a dataset.
12
+
13
+ Args:
14
+ dataset_id: Dataset ID from the catalog (e.g., 'wdbc', 'iris').
15
+ verbose: Print progress to stdout; "log" also prints the server's log for the job.
16
+ on_progress: Callback(percent, message) for progress updates.
17
+
18
+ Returns:
19
+ Dict with variance_ratios, cumulative_variance, thresholds, etc.
20
+ """
21
+ if self._client.core: # local mode: call the core directly
22
+ return self._client._run_local(self._client.core.pca, dataset_id,
23
+ verbose=verbose, on_progress=on_progress)
24
+ return self._client._run_job(
25
+ "/analysis/pca",
26
+ "/analysis/pca/{job_id}/stream",
27
+ body={"dataset_id": dataset_id},
28
+ verbose=verbose,
29
+ on_progress=on_progress,
30
+ )
31
+
32
+ def mi(self, dataset_id, verbose=False, on_progress=None):
33
+ """Run Mutual Information feature importance analysis.
34
+
35
+ Args:
36
+ dataset_id: Dataset ID from the catalog.
37
+ verbose: Print progress to stdout; "log" also prints the server's log for the job.
38
+ on_progress: Callback(percent, message) for progress updates.
39
+
40
+ Returns:
41
+ Dict with ranked_features, cumulative_mi, thresholds, etc.
42
+ """
43
+ if self._client.core: # local mode: call the core directly
44
+ return self._client._run_local(self._client.core.mi, dataset_id,
45
+ verbose=verbose, on_progress=on_progress)
46
+ return self._client._run_job(
47
+ "/analysis/mi",
48
+ "/analysis/mi/{job_id}/stream",
49
+ body={"dataset_id": dataset_id},
50
+ verbose=verbose,
51
+ on_progress=on_progress,
52
+ )
53
+
54
+ def qre(self, dataset_id, verbose=False, on_progress=None):
55
+ """Run Quantum Resource Estimation.
56
+
57
+ Args:
58
+ dataset_id: Dataset ID from the catalog.
59
+ verbose: Print progress to stdout; "log" also prints the server's log for the job.
60
+ on_progress: Callback(percent, message) for progress updates.
61
+
62
+ Returns:
63
+ Dict with estimatedQubits, standardDeviation, plotData, etc.
64
+ """
65
+ if self._client.core: # local mode: call the core directly
66
+ return self._client._run_local(self._client.core.qre, dataset_id,
67
+ verbose=verbose, on_progress=on_progress)
68
+ return self._client._run_job(
69
+ "/analysis/qre",
70
+ "/analysis/qre/{job_id}/stream",
71
+ body={"dataset_id": dataset_id},
72
+ verbose=verbose,
73
+ on_progress=on_progress,
74
+ )
@@ -0,0 +1,136 @@
1
+ """The redcedar command: train, evaluate and predict from the command line.
2
+
3
+ redcedar train my_data.csv --qubits 6 --seed 123
4
+ redcedar evaluate <train_id>
5
+ redcedar predict <train_id> new_data.csv -o predictions.csv
6
+ redcedar models
7
+ redcedar status
8
+
9
+ The server comes from --url / --api-key, or REDCEDAR_URL / REDCEDAR_API_KEY.
10
+ """
11
+
12
+ import argparse
13
+ import sys
14
+
15
+ import requests
16
+
17
+ from .client import connect
18
+
19
+
20
+ def main(argv=None):
21
+ p = argparse.ArgumentParser(prog="redcedar", description="Red Cedar quantum machine learning")
22
+ p.add_argument("--url", help="server URL (default: REDCEDAR_URL or http://127.0.0.1:8002)")
23
+ p.add_argument("--api-key", help="API key (default: REDCEDAR_API_KEY)")
24
+ p.add_argument("--local", action="store_true",
25
+ help="call the Red Cedar core directly in this process instead of a server "
26
+ "(redcedar_core, installed with pip install -e, or the red-cedar folder "
27
+ "in REDCEDAR_CORE_PATH)")
28
+ p.add_argument("-q", "--quiet", action="store_true", help="no progress output")
29
+ p.add_argument("--log", action="store_true", help="also print the server's log for the job")
30
+ sub = p.add_subparsers(dest="command", required=True)
31
+
32
+ t = sub.add_parser("train", help="train a model on a CSV file or catalog dataset")
33
+ t.add_argument("data", help="CSV file path or catalog dataset ID")
34
+ t.add_argument("--settings", help="settings file (.json or .toml)")
35
+ t.add_argument("--qubits", type=int, help="num_qubits")
36
+ t.add_argument("--layers", type=int, help="train layers 1 to N (min_layers=1, max_layers=N)")
37
+ t.add_argument("--seed", type=int, help="seed for the initial parameters")
38
+ t.add_argument("--backend", help="where the circuits run (default: statevector)")
39
+ t.add_argument("--task", choices=["classification", "regression"],
40
+ help="default: detected from the target column")
41
+ t.add_argument("--test-size", type=float,
42
+ help="held-out test rows, a fraction or a count (0 = train on all rows)")
43
+
44
+ e = sub.add_parser("evaluate", help="score a model on its held-out test rows")
45
+ e.add_argument("train_id")
46
+ e.add_argument("--layer", type=int)
47
+ e.add_argument("--backend")
48
+
49
+ r = sub.add_parser("predict", help="predictions for new rows")
50
+ r.add_argument("train_id")
51
+ r.add_argument("data", help="CSV file with the new rows")
52
+ r.add_argument("-o", "--output", help="write the rows and predictions to this CSV file")
53
+ r.add_argument("--layer", type=int)
54
+ r.add_argument("--backend")
55
+
56
+ sub.add_parser("models", help="list recently trained models")
57
+ sub.add_parser("status", help="check the server and show the server and SDK versions")
58
+
59
+ args = p.parse_args(argv)
60
+ client = connect(url=args.url, api_key=args.api_key, local=args.local or False)
61
+ verbose = False if args.quiet else "log" if args.log else True
62
+ run_settings = {"backend": args.backend} if getattr(args, "backend", None) else None
63
+
64
+ try:
65
+ if args.command == "train":
66
+ from .settings import load_settings
67
+ settings = load_settings(args.settings)
68
+ if args.qubits is not None:
69
+ settings["num_qubits"] = args.qubits
70
+ if args.layers is not None:
71
+ settings["min_layers"], settings["max_layers"] = 1, args.layers
72
+ if args.seed is not None:
73
+ settings["seed"] = args.seed
74
+ if args.backend:
75
+ settings["backend"] = args.backend
76
+ test_size = args.test_size
77
+ if test_size is not None and test_size >= 1:
78
+ test_size = int(test_size)
79
+ result = client.training.run(args.data, settings=settings, verbose=verbose,
80
+ task=args.task, test_size=test_size)
81
+ for layer, v in result.get("validation", {}).items():
82
+ if v.get("test_accuracy") is not None:
83
+ print(f"Layer {layer}: test accuracy {v['test_accuracy']:.1%}")
84
+ elif v.get("test_loss") is not None:
85
+ print(f"Layer {layer}: test loss {v['test_loss']:.4f}")
86
+ else:
87
+ print(f"Layer {layer}: trained on all rows (no test set)")
88
+ print(f"train_id: {result['train_id']}")
89
+
90
+ elif args.command == "evaluate":
91
+ report = client.training.evaluate(args.train_id, layer=args.layer, verbose=verbose,
92
+ settings=run_settings)
93
+ if report.get("task") == "regression":
94
+ print(f"Mean absolute error {report['mean_absolute_error']:.4f}, "
95
+ f"loss {report['overall_loss']:.4f} on {report['test_samples']} test rows")
96
+ else:
97
+ print(f"Accuracy {report['overall_accuracy']:.1%} on {report['test_samples']} test rows")
98
+ for c in report["per_class"]:
99
+ print(f" class {c['class']}: {c['accuracy']:.1%} ({c['samples']} rows)")
100
+
101
+ elif args.command == "predict":
102
+ result = client.inference.run(args.train_id, args.data, layer=args.layer,
103
+ output=args.output, verbose=verbose,
104
+ settings=run_settings)
105
+ if args.output:
106
+ print(f"{result['rows']} predictions written to {args.output}")
107
+ else:
108
+ for p_row in result["predictions"]:
109
+ print(p_row["prediction"])
110
+ if "accuracy" in result:
111
+ print(f"Accuracy on these rows: {result['accuracy']:.1%}")
112
+ if "mean_absolute_error" in result:
113
+ print(f"Mean absolute error on these rows: {result['mean_absolute_error']:.4f}")
114
+
115
+ elif args.command == "models":
116
+ for m in client.inference.models()["models"]:
117
+ print(m["train_id"], m.get("dataset_display_name") or m.get("dataset", ""),
118
+ m.get("task", ""), f"{m.get('num_qubits')} qubits", f"layers {m.get('layers')}")
119
+
120
+ elif args.command == "status":
121
+ s = client.status()
122
+ print(f"Server: {client.url or 'none (local mode: the Red Cedar core in this process)'}")
123
+ print(f"Server version: {s['server_version'] or 'unknown'}")
124
+ print(f"SDK version: {s['sdk_version']}")
125
+ if not s["ok"]:
126
+ print(f"Error: {s['error']}", file=sys.stderr)
127
+ return 1
128
+
129
+ except (RuntimeError, requests.HTTPError, requests.ConnectionError, FileNotFoundError) as err:
130
+ print(f"Error: {err}", file=sys.stderr)
131
+ return 1
132
+ return 0
133
+
134
+
135
+ if __name__ == "__main__":
136
+ sys.exit(main())