@@ -157,7 +157,7 @@ client.requirements.check(
157
157
</details >
158
158
159
159
## pic
160
- <details ><summary ><code >client.pic.<a href =" src/axiomatic/pic/client.py " >find_mappings </a >(...)</code ></summary >
160
+ <details ><summary ><code >client.pic.<a href =" src/axiomatic/pic/client.py " >find_mapping </a >(...)</code ></summary >
161
161
<dl >
162
162
<dd >
163
163
@@ -184,27 +184,19 @@ Map variables in the constraints to computations on the netlist.
184
184
<dd >
185
185
186
186
``` python
187
- from axiomatic import Axiomatic, Netlist, PicComponent, Statement
187
+ from axiomatic import Axiomatic, Netlist, PicInstance, StatementDictionary
188
188
189
189
client = Axiomatic(
190
190
api_key = " YOUR_API_KEY" ,
191
191
)
192
- client.pic.find_mappings(
193
- statements = [
194
- Statement(
195
- id = " id" ,
196
- statement = " statement" ,
197
- )
198
- ],
192
+ client.pic.find_mapping(
193
+ statements = StatementDictionary(),
199
194
netlist = Netlist(
200
- name = " name" ,
201
195
instances = {
202
- " key" : PicComponent (
196
+ " key" : PicInstance (
203
197
component = " component" ,
204
198
)
205
199
},
206
- connections = {" key" : " value" },
207
- ports = {" key" : " value" },
208
200
),
209
201
)
210
202
@@ -222,7 +214,7 @@ client.pic.find_mappings(
222
214
<dl >
223
215
<dd >
224
216
225
- ** statements:** ` typing.Sequence[Statement] `
217
+ ** statements:** ` StatementDictionary `
226
218
227
219
</dd >
228
220
</dl >
@@ -823,6 +815,14 @@ core.File` — See core.File for more documentation
823
815
<dl >
824
816
<dd >
825
817
818
+ ** ocr:** ` typing.Optional[bool] ` — Whether to use OCR
819
+
820
+ </dd >
821
+ </dl >
822
+
823
+ <dl >
824
+ <dd >
825
+
826
826
** request_options:** ` typing.Optional[RequestOptions] ` — Request-specific configuration.
827
827
828
828
</dd >
@@ -848,7 +848,7 @@ core.File` — See core.File for more documentation
848
848
<dl >
849
849
<dd >
850
850
851
- Executes code in a secure environment
851
+ Execute python code, and return the standard output. If an error occurs, it will be returned in the error_trace field. Importing from the following modules is supported: gdsfactory
852
852
</dd >
853
853
</dl >
854
854
</dd >
@@ -1116,6 +1116,86 @@ client.lean.z_3.execute(
1116
1116
</dl >
1117
1117
1118
1118
1119
+ </dd >
1120
+ </dl >
1121
+ </details >
1122
+
1123
+ ## Pic Document
1124
+ <details ><summary ><code >client.pic.document.<a href =" src/axiomatic/pic/document/client.py " >summarize</a >(...)</code ></summary >
1125
+ <dl >
1126
+ <dd >
1127
+
1128
+ #### 📝 Description
1129
+
1130
+ <dl >
1131
+ <dd >
1132
+
1133
+ <dl >
1134
+ <dd >
1135
+
1136
+ Generate GDS factory code to create a PIC component
1137
+ </dd >
1138
+ </dl >
1139
+ </dd >
1140
+ </dl >
1141
+
1142
+ #### 🔌 Usage
1143
+
1144
+ <dl >
1145
+ <dd >
1146
+
1147
+ <dl >
1148
+ <dd >
1149
+
1150
+ ``` python
1151
+ from axiomatic import Axiomatic
1152
+
1153
+ client = Axiomatic(
1154
+ api_key = " YOUR_API_KEY" ,
1155
+ )
1156
+ client.pic.document.summarize(
1157
+ query = " query" ,
1158
+ images = [" images" ],
1159
+ )
1160
+
1161
+ ```
1162
+ </dd >
1163
+ </dl >
1164
+ </dd >
1165
+ </dl >
1166
+
1167
+ #### ⚙️ Parameters
1168
+
1169
+ <dl >
1170
+ <dd >
1171
+
1172
+ <dl >
1173
+ <dd >
1174
+
1175
+ ** query:** ` str `
1176
+
1177
+ </dd >
1178
+ </dl >
1179
+
1180
+ <dl >
1181
+ <dd >
1182
+
1183
+ ** images:** ` typing.Sequence[str] `
1184
+
1185
+ </dd >
1186
+ </dl >
1187
+
1188
+ <dl >
1189
+ <dd >
1190
+
1191
+ ** request_options:** ` typing.Optional[RequestOptions] ` — Request-specific configuration.
1192
+
1193
+ </dd >
1194
+ </dl >
1195
+ </dd >
1196
+ </dl >
1197
+
1198
+
1119
1199
</dd >
1120
1200
</dl >
1121
1201
</details >
@@ -1374,35 +1454,36 @@ Optimize a PIC circuit with given cost and constraints
1374
1454
<dd >
1375
1455
1376
1456
``` python
1377
- from axiomatic import Axiomatic, Mapping, Netlist, PicComponent, Statement
1457
+ from axiomatic import (
1458
+ Axiomatic,
1459
+ Computation,
1460
+ Netlist,
1461
+ Parameter,
1462
+ PicInstance,
1463
+ StatementDictionary,
1464
+ )
1378
1465
1379
1466
client = Axiomatic(
1380
1467
api_key = " YOUR_API_KEY" ,
1381
1468
)
1382
1469
client.pic.circuit.optimize(
1383
1470
netlist = Netlist(
1384
- name = " name" ,
1385
1471
instances = {
1386
- " key" : PicComponent (
1472
+ " key" : PicInstance (
1387
1473
component = " component" ,
1388
1474
)
1389
1475
},
1390
- connections = {" key" : " value" },
1391
- ports = {" key" : " value" },
1392
1476
),
1393
- statements = [
1394
- Statement(
1395
- id = " id" ,
1396
- statement = " statement" ,
1477
+ statements = StatementDictionary(),
1478
+ mappings = {
1479
+ " key" : Computation(
1480
+ name = " name" ,
1481
+ arguments = {" key" : 1.1 },
1397
1482
)
1398
- ],
1399
- mappings = [
1400
- Mapping(
1401
- statement_id = " statement_id" ,
1402
- expression_idx = 1 ,
1403
- variable = " variable" ,
1404
- computation_name = " computation_name" ,
1405
- computation_arguments = {" key" : 1.1 },
1483
+ },
1484
+ parameters = [
1485
+ Parameter(
1486
+ path = " path" ,
1406
1487
)
1407
1488
],
1408
1489
)
@@ -1429,15 +1510,23 @@ client.pic.circuit.optimize(
1429
1510
<dl >
1430
1511
<dd >
1431
1512
1432
- ** statements:** ` typing.Sequence[Statement] `
1513
+ ** statements:** ` StatementDictionary `
1514
+
1515
+ </dd >
1516
+ </dl >
1517
+
1518
+ <dl >
1519
+ <dd >
1520
+
1521
+ ** mappings:** ` typing.Dict[str, Computation] `
1433
1522
1434
1523
</dd >
1435
1524
</dl >
1436
1525
1437
1526
<dl >
1438
1527
<dd >
1439
1528
1440
- ** mappings :** ` typing.Sequence[Mapping ] `
1529
+ ** parameters :** ` typing.Sequence[Parameter ] `
1441
1530
1442
1531
</dd >
1443
1532
</dl >
0 commit comments