Skip to content

Commit 43b6e61

Browse files
committed
Release 0.0.36
1 parent a99fbd6 commit 43b6e61

15 files changed

+741
-338
lines changed

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "axiomatic"
33

44
[tool.poetry]
55
name = "axiomatic"
6-
version = "0.0.35"
6+
version = "0.0.36"
77
description = ""
88
readme = "README.md"
99
authors = []

reference.md

Lines changed: 200 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -152,100 +152,6 @@ client.requirements.check(
152152
</dl>
153153

154154

155-
</dd>
156-
</dl>
157-
</details>
158-
159-
## pic
160-
<details><summary><code>client.pic.<a href="src/axiomatic/pic/client.py">find_mapping</a>(...)</code></summary>
161-
<dl>
162-
<dd>
163-
164-
#### 📝 Description
165-
166-
<dl>
167-
<dd>
168-
169-
<dl>
170-
<dd>
171-
172-
Map variables in the constraints to computations on the netlist.
173-
</dd>
174-
</dl>
175-
</dd>
176-
</dl>
177-
178-
#### 🔌 Usage
179-
180-
<dl>
181-
<dd>
182-
183-
<dl>
184-
<dd>
185-
186-
```python
187-
from axiomatic import Axiomatic, Netlist, PicInstance, StatementDictionary
188-
189-
client = Axiomatic(
190-
api_key="YOUR_API_KEY",
191-
)
192-
client.pic.find_mapping(
193-
statements=StatementDictionary(),
194-
netlist=Netlist(
195-
instances={
196-
"key": PicInstance(
197-
component="component",
198-
)
199-
},
200-
),
201-
)
202-
203-
```
204-
</dd>
205-
</dl>
206-
</dd>
207-
</dl>
208-
209-
#### ⚙️ Parameters
210-
211-
<dl>
212-
<dd>
213-
214-
<dl>
215-
<dd>
216-
217-
**statements:** `StatementDictionary`
218-
219-
</dd>
220-
</dl>
221-
222-
<dl>
223-
<dd>
224-
225-
**netlist:** `Netlist`
226-
227-
</dd>
228-
</dl>
229-
230-
<dl>
231-
<dd>
232-
233-
**max_iter:** `typing.Optional[int]`
234-
235-
</dd>
236-
</dl>
237-
238-
<dl>
239-
<dd>
240-
241-
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
242-
243-
</dd>
244-
</dl>
245-
</dd>
246-
</dl>
247-
248-
249155
</dd>
250156
</dl>
251157
</details>
@@ -1201,6 +1107,111 @@ client.pic.document.summarize(
12011107
</details>
12021108

12031109
## Pic Circuit
1110+
<details><summary><code>client.pic.circuit.<a href="src/axiomatic/pic/circuit/client.py">validate</a>(...)</code></summary>
1111+
<dl>
1112+
<dd>
1113+
1114+
#### 📝 Description
1115+
1116+
<dl>
1117+
<dd>
1118+
1119+
<dl>
1120+
<dd>
1121+
1122+
Validates a set of statements against a netlist.
1123+
</dd>
1124+
</dl>
1125+
</dd>
1126+
</dl>
1127+
1128+
#### 🔌 Usage
1129+
1130+
<dl>
1131+
<dd>
1132+
1133+
<dl>
1134+
<dd>
1135+
1136+
```python
1137+
from axiomatic import (
1138+
Axiomatic,
1139+
Computation,
1140+
Netlist,
1141+
PicInstance,
1142+
StatementDictionary,
1143+
)
1144+
1145+
client = Axiomatic(
1146+
api_key="YOUR_API_KEY",
1147+
)
1148+
client.pic.circuit.validate(
1149+
netlist=Netlist(
1150+
instances={
1151+
"key": PicInstance(
1152+
component="component",
1153+
)
1154+
},
1155+
),
1156+
statements=StatementDictionary(),
1157+
mapping={
1158+
"key": Computation(
1159+
name="name",
1160+
arguments={"key": 1.1},
1161+
)
1162+
},
1163+
)
1164+
1165+
```
1166+
</dd>
1167+
</dl>
1168+
</dd>
1169+
</dl>
1170+
1171+
#### ⚙️ Parameters
1172+
1173+
<dl>
1174+
<dd>
1175+
1176+
<dl>
1177+
<dd>
1178+
1179+
**netlist:** `Netlist`
1180+
1181+
</dd>
1182+
</dl>
1183+
1184+
<dl>
1185+
<dd>
1186+
1187+
**statements:** `StatementDictionary`
1188+
1189+
</dd>
1190+
</dl>
1191+
1192+
<dl>
1193+
<dd>
1194+
1195+
**mapping:** `typing.Dict[str, Computation]`
1196+
1197+
</dd>
1198+
</dl>
1199+
1200+
<dl>
1201+
<dd>
1202+
1203+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1204+
1205+
</dd>
1206+
</dl>
1207+
</dd>
1208+
</dl>
1209+
1210+
1211+
</dd>
1212+
</dl>
1213+
</details>
1214+
12041215
<details><summary><code>client.pic.circuit.<a href="src/axiomatic/pic/circuit/client.py">formalize</a>(...)</code></summary>
12051216
<dl>
12061217
<dd>
@@ -1267,6 +1278,99 @@ client.pic.circuit.formalize(
12671278
</dl>
12681279

12691280

1281+
</dd>
1282+
</dl>
1283+
</details>
1284+
1285+
<details><summary><code>client.pic.circuit.<a href="src/axiomatic/pic/circuit/client.py">mapping</a>(...)</code></summary>
1286+
<dl>
1287+
<dd>
1288+
1289+
#### 📝 Description
1290+
1291+
<dl>
1292+
<dd>
1293+
1294+
<dl>
1295+
<dd>
1296+
1297+
Map variables in the constraints to computations on the netlist.
1298+
</dd>
1299+
</dl>
1300+
</dd>
1301+
</dl>
1302+
1303+
#### 🔌 Usage
1304+
1305+
<dl>
1306+
<dd>
1307+
1308+
<dl>
1309+
<dd>
1310+
1311+
```python
1312+
from axiomatic import Axiomatic, Netlist, PicInstance, StatementDictionary
1313+
1314+
client = Axiomatic(
1315+
api_key="YOUR_API_KEY",
1316+
)
1317+
client.pic.circuit.mapping(
1318+
statements=StatementDictionary(),
1319+
netlist=Netlist(
1320+
instances={
1321+
"key": PicInstance(
1322+
component="component",
1323+
)
1324+
},
1325+
),
1326+
)
1327+
1328+
```
1329+
</dd>
1330+
</dl>
1331+
</dd>
1332+
</dl>
1333+
1334+
#### ⚙️ Parameters
1335+
1336+
<dl>
1337+
<dd>
1338+
1339+
<dl>
1340+
<dd>
1341+
1342+
**statements:** `StatementDictionary`
1343+
1344+
</dd>
1345+
</dl>
1346+
1347+
<dl>
1348+
<dd>
1349+
1350+
**netlist:** `Netlist`
1351+
1352+
</dd>
1353+
</dl>
1354+
1355+
<dl>
1356+
<dd>
1357+
1358+
**max_iter:** `typing.Optional[int]`
1359+
1360+
</dd>
1361+
</dl>
1362+
1363+
<dl>
1364+
<dd>
1365+
1366+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1367+
1368+
</dd>
1369+
</dl>
1370+
</dd>
1371+
</dl>
1372+
1373+
12701374
</dd>
12711375
</dl>
12721376
</details>
@@ -1475,7 +1579,7 @@ client.pic.circuit.optimize(
14751579
},
14761580
),
14771581
statements=StatementDictionary(),
1478-
mappings={
1582+
mapping={
14791583
"key": Computation(
14801584
name="name",
14811585
arguments={"key": 1.1},
@@ -1518,7 +1622,7 @@ client.pic.circuit.optimize(
15181622
<dl>
15191623
<dd>
15201624

1521-
**mappings:** `typing.Dict[str, Computation]`
1625+
**mapping:** `typing.Dict[str, Computation]`
15221626

15231627
</dd>
15241628
</dl>

src/axiomatic/__init__.py

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@
1010
FormalizationError,
1111
FormalizeCircuitResponse,
1212
FormalizeResponse,
13-
FunctionCall,
14-
FunctionCallArgumentsValue,
15-
FunctionCallExpectedResult,
1613
GenerateCodeResponse,
1714
GenerateComponentCodeResponse,
1815
HttpValidationError,
@@ -35,8 +32,14 @@
3532
SolutionResponseSolutionValue,
3633
Statement,
3734
StatementDictionary,
35+
StatementFeedback,
36+
StatementFeedbackDictionary,
3837
StatementType,
38+
StructureFunctionCall,
39+
StructureFunctionCallArgumentsValue,
40+
StructureFunctionCallExpectedResult,
3941
SummarizerResponse,
42+
ValidateNetlistResponse,
4043
ValidateResponse,
4144
ValidationError,
4245
ValidationErrorLocItem,
@@ -63,9 +66,6 @@
6366
"FormalizationError",
6467
"FormalizeCircuitResponse",
6568
"FormalizeResponse",
66-
"FunctionCall",
67-
"FunctionCallArgumentsValue",
68-
"FunctionCallExpectedResult",
6969
"GenerateCodeResponse",
7070
"GenerateComponentCodeResponse",
7171
"HttpValidationError",
@@ -88,9 +88,15 @@
8888
"SolutionResponseSolutionValue",
8989
"Statement",
9090
"StatementDictionary",
91+
"StatementFeedback",
92+
"StatementFeedbackDictionary",
9193
"StatementType",
94+
"StructureFunctionCall",
95+
"StructureFunctionCallArgumentsValue",
96+
"StructureFunctionCallExpectedResult",
9297
"SummarizerResponse",
9398
"UnprocessableEntityError",
99+
"ValidateNetlistResponse",
94100
"ValidateResponse",
95101
"ValidationError",
96102
"ValidationErrorLocItem",

0 commit comments

Comments
 (0)