Skip to content

Commit fd651be

Browse files
fern-api[bot]fern-api[bot]
committed
Release 0.0.136
1 parent 4e7dd67 commit fd651be

24 files changed

+1052
-46
lines changed

‎poetry.lock

+10-10
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pyproject.toml

+1-1
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.135"
6+
version = "0.0.136"
77
description = ""
88
readme = "README.md"
99
authors = []

‎reference.md

+253-1
Original file line numberDiff line numberDiff line change
@@ -901,6 +901,188 @@ client.tools.list()
901901
</dl>
902902

903903

904+
</dd>
905+
</dl>
906+
</details>
907+
908+
## DigitalTwin
909+
<details><summary><code>client.digital_twin.<a href="src/axiomatic/digital_twin/client.py">optimize</a>(...)</code></summary>
910+
<dl>
911+
<dd>
912+
913+
#### 📝 Description
914+
915+
<dl>
916+
<dd>
917+
918+
<dl>
919+
<dd>
920+
921+
Fits a digital twin model to input data using numerical optimization.
922+
923+
Accepts parameter guesses, bounds, inputs, targets, and constants — all with units —
924+
and returns the optimized parameters that minimize the model's error using a selected cost function.
925+
926+
Args:
927+
OptimizerBody: The input data and optimization parameters.
928+
Returns:
929+
OptimizerResult: The result of the optimization.
930+
</dd>
931+
</dl>
932+
</dd>
933+
</dl>
934+
935+
#### 🔌 Usage
936+
937+
<dl>
938+
<dd>
939+
940+
<dl>
941+
<dd>
942+
943+
```python
944+
from axiomatic import (
945+
Axiomatic,
946+
NamedQuantity,
947+
NamedQuantityList,
948+
ParameterBound,
949+
Quantity,
950+
QuantityList,
951+
)
952+
953+
client = Axiomatic(
954+
api_key="YOUR_API_KEY",
955+
)
956+
client.digital_twin.optimize(
957+
parameters=[
958+
NamedQuantity(
959+
name="name",
960+
value=Quantity(
961+
magnitude=1.1,
962+
unit="unit",
963+
),
964+
)
965+
],
966+
parameter_bounds=[
967+
ParameterBound(
968+
name="name",
969+
lower=Quantity(
970+
magnitude=1.1,
971+
unit="unit",
972+
),
973+
upper=Quantity(
974+
magnitude=1.1,
975+
unit="unit",
976+
),
977+
)
978+
],
979+
constants=[
980+
NamedQuantity(
981+
name="name",
982+
value=Quantity(
983+
magnitude=1.1,
984+
unit="unit",
985+
),
986+
)
987+
],
988+
inputs=[
989+
NamedQuantityList(
990+
name="name",
991+
value=QuantityList(
992+
unit="unit",
993+
magnitude=[1.1],
994+
),
995+
)
996+
],
997+
targets=[
998+
NamedQuantityList(
999+
name="name",
1000+
value=QuantityList(
1001+
unit="unit",
1002+
magnitude=[1.1],
1003+
),
1004+
)
1005+
],
1006+
)
1007+
1008+
```
1009+
</dd>
1010+
</dl>
1011+
</dd>
1012+
</dl>
1013+
1014+
#### ⚙️ Parameters
1015+
1016+
<dl>
1017+
<dd>
1018+
1019+
<dl>
1020+
<dd>
1021+
1022+
**parameters:** `typing.Sequence[NamedQuantity]`
1023+
1024+
</dd>
1025+
</dl>
1026+
1027+
<dl>
1028+
<dd>
1029+
1030+
**parameter_bounds:** `typing.Sequence[ParameterBound]`
1031+
1032+
</dd>
1033+
</dl>
1034+
1035+
<dl>
1036+
<dd>
1037+
1038+
**constants:** `typing.Sequence[NamedQuantity]`
1039+
1040+
</dd>
1041+
</dl>
1042+
1043+
<dl>
1044+
<dd>
1045+
1046+
**inputs:** `typing.Sequence[NamedQuantityList]`
1047+
1048+
</dd>
1049+
</dl>
1050+
1051+
<dl>
1052+
<dd>
1053+
1054+
**targets:** `typing.Sequence[NamedQuantityList]`
1055+
1056+
</dd>
1057+
</dl>
1058+
1059+
<dl>
1060+
<dd>
1061+
1062+
**tolerance:** `typing.Optional[float]`
1063+
1064+
</dd>
1065+
</dl>
1066+
1067+
<dl>
1068+
<dd>
1069+
1070+
**max_time:** `typing.Optional[int]`
1071+
1072+
</dd>
1073+
</dl>
1074+
1075+
<dl>
1076+
<dd>
1077+
1078+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1079+
1080+
</dd>
1081+
</dl>
1082+
</dd>
1083+
</dl>
1084+
1085+
9041086
</dd>
9051087
</dl>
9061088
</details>
@@ -1059,7 +1241,77 @@ core.File` — See core.File for more documentation
10591241
<dl>
10601242
<dd>
10611243

1062-
**get_platform_data:** `typing.Optional[bool]` — Whether to get concise version of data for the platform
1244+
**v2:** `typing.Optional[bool]` — Get v2 of plot parser output. (v1 will be deprecated soon)
1245+
1246+
</dd>
1247+
</dl>
1248+
1249+
<dl>
1250+
<dd>
1251+
1252+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
1253+
1254+
</dd>
1255+
</dl>
1256+
</dd>
1257+
</dl>
1258+
1259+
1260+
</dd>
1261+
</dl>
1262+
</details>
1263+
1264+
<details><summary><code>client.document.plot.<a href="src/axiomatic/document/plot/client.py">split</a>(...)</code></summary>
1265+
<dl>
1266+
<dd>
1267+
1268+
#### 📝 Description
1269+
1270+
<dl>
1271+
<dd>
1272+
1273+
<dl>
1274+
<dd>
1275+
1276+
Splits a plot into multiple subplots if they exist
1277+
</dd>
1278+
</dl>
1279+
</dd>
1280+
</dl>
1281+
1282+
#### 🔌 Usage
1283+
1284+
<dl>
1285+
<dd>
1286+
1287+
<dl>
1288+
<dd>
1289+
1290+
```python
1291+
from axiomatic import Axiomatic
1292+
1293+
client = Axiomatic(
1294+
api_key="YOUR_API_KEY",
1295+
)
1296+
client.document.plot.split()
1297+
1298+
```
1299+
</dd>
1300+
</dl>
1301+
</dd>
1302+
</dl>
1303+
1304+
#### ⚙️ Parameters
1305+
1306+
<dl>
1307+
<dd>
1308+
1309+
<dl>
1310+
<dd>
1311+
1312+
**plot_img:** `from __future__ import annotations
1313+
1314+
core.File` — See core.File for more documentation
10631315

10641316
</dd>
10651317
</dl>

0 commit comments

Comments
 (0)