simaticai 2.4.0__py3-none-any.whl

simaticai/README.md

@@ -0,0 +1 @@
+The `simaticai` namespace combines the AI SDK components. The `simaticai` python package provides the core modules listed below. Other `simaticai_*` python packages extend this namespace with their own submodules.

simaticai/__main__.py

@@ -0,0 +1,34 @@
+# Copyright (C) Siemens AG 2021. All Rights Reserved. Confidential.
+
+"""
+AI Software Development Kit CLI
+"""
+
+import argparse
+
+from simaticai import deployment
+
+argparser = argparse.ArgumentParser(prog='python -m simaticai', description="AI SDK command line interface.", add_help=True)
+cmd_parsers = argparser.add_subparsers(dest='command')
+
+parser_convert_package = cmd_parsers.add_parser('convert_package', help="Convert a Pipeline Configuration Package to an Edge Configuration Package that can be directly deployed.")
+parser_convert_package.add_argument('package_zip', help="""Path to the input package file.
+For "{path}/{name}_{version}.zip", the output file will be created as "{path}/{name}-edge_{version}.zip".
+If a file with such a name already exists, it is overwritten.""")
+
+parser_delta_package = cmd_parsers.add_parser('create_delta_package', help="Create a Delta Configuration Package that can be deployed onto the original pipeline on AI Inference Server.")
+parser_delta_package.add_argument('origin_package', help="Path to Origin Edge Package file.")
+parser_delta_package.add_argument('new_package', help="Path to New Edge Package file.")
+
+
+args = argparser.parse_args()
+
+if args.command == "convert_package":
+    target_zip = deployment.convert_package(args.package_zip)
+    print(f"Package successfully converted and saved as '{target_zip}'")
+
+elif args.command == "create_delta_package":
+    target_zip = deployment.create_delta_package(args.origin_package, args.new_package)
+    print(f"Delta package successfully created and saved as '{target_zip}'")
+else:
+    argparser.error("No subcommand selected.")

simaticai/data/__init__.py

@@ -0,0 +1,7 @@
+# Copyright (C) Siemens AG 2021. All Rights Reserved. Confidential.
+
+"""
+This module contains additional files for AI SDK.
+
+These files are necessary for some functionalities of the SDK.
+"""

simaticai/data/schemas/__init__.py

@@ -0,0 +1,8 @@
+# Copyright (C) Siemens AG 2021. All Rights Reserved. Confidential.
+
+"""
+This module contains the schema files used in validation methods.
+
+These JSON schema files describe the configuration YAML files' schema
+for AI Inference Server.
+"""

simaticai/data/schemas/datalink.schema.json

@@ -0,0 +1,161 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "#/properties/datalink_metadata",
+    "type": "object",
+    "title": "Datalink Metadata",
+    "description": "Describes the minimal content on the Datalink Metadata file.",
+    "default": {},
+    "examples": [
+        {
+            "fileFormatVersion": 1,
+            "id": "70aa432a-8dcb-4015-8b68-b3ad0ae7a62a",
+            "version": "0.0.1",
+            "createdOn": "2021-03-16T09:57:16.692Z",
+            "inputs": [
+                {
+                    "name": "temperature",
+                    "mapping": "ie/d/j/simatic/v1/s7c1/dp/r/BozokiAir/default:BozokiAir_DB_temperature",
+                    "type": "Real"
+                },
+                {
+                    "name": "pressure",
+                    "mapping": "ie/d/j/simatic/v1/s7c1/dp/r/BozokiAir/default:BozokiAir_DB_pressure",
+                    "type": "Real"
+                },
+                {
+                    "name": "density",
+                    "mapping": "ie/d/j/simatic/v1/s7c1/dp/r/BozokiAir/default:BozokiAir_DB_density",
+                    "type": "Real"
+                }
+            ]
+        }
+    ],
+    "required": [
+        "fileFormatVersion",
+        "id",
+        "version",
+        "createdOn",
+        "inputs"
+    ],
+    "properties": {
+        "fileFormatVersion": {
+            "$id": "#/properties/fileFormatVersion",
+            "type": "string",
+            "title": "fileFormatVersion",
+            "description": "Configuration file format version",
+            "examples": [
+                1
+            ]
+        },
+        "id": {
+            "$id": "#/properties/id",
+            "type": "string",
+            "title": "id",
+            "description": "Dataset id",
+            "default": "",
+            "examples": [
+                "70aa432a-8dcb-4015-8b68-b3ad0ae7a62a"
+            ]
+        },
+        "version": {
+            "$id": "#/properties/version",
+            "type": "string",
+            "title": "version",
+            "description": "Dataset version",
+            "default": "",
+            "examples": [
+                "0.0.1"
+            ]
+        },
+        "createdOn": {
+            "$id": "#/properties/createdOn",
+            "type": "string",
+            "title": "createdOn",
+            "description": "Dataset creation ISO datetime ",
+            "default": "",
+            "examples": [
+                "2021-03-16T09:57:16.692Z"
+            ]
+        },
+        "inputs": {
+            "$id": "#/properties/inputs",
+            "type": "array",
+            "title": "inputs",
+            "description": "Dataset variable list, commonly are the predicted model input/features",
+            "default": [],
+            "examples": [
+                [
+                    {
+                        "name": "temperature",
+                        "mapping": "ie/d/j/simatic/v1/s7c1/dp/r/BozokiAir/default:BozokiAir_DB_temperature",
+                        "type": "Real"
+                    },
+                    {
+                        "name": "pressure",
+                        "mapping": "ie/d/j/simatic/v1/s7c1/dp/r/BozokiAir/default:BozokiAir_DB_pressure",
+                        "type": "Real"
+                    }
+                ]
+            ],
+            "additionalItems": true,
+            "items": {
+                "$id": "#/properties/inputs/items",
+                "anyOf": [
+                    {
+                        "$id": "#/properties/inputs/items/anyOf/0",
+                        "type": "object",
+                        "title": "variable detail",
+                        "description": "Specify the variables information, how it links with the Databus",
+                        "default": {},
+                        "examples": [
+                            {
+                                "name": "temperature",
+                                "mapping": "ie/d/j/simatic/v1/s7c1/dp/r/BozokiAir/default:BozokiAir_DB_temperature",
+                                "type": "Real"
+                            }
+                        ],
+                        "required": [
+                            "name",
+                            "mapping",
+                            "type"
+                        ],
+                        "properties": {
+                            "name": {
+                                "$id": "#/properties/inputs/items/anyOf/0/properties/name",
+                                "type": "string",
+                                "title": "variable name",
+                                "description": "Name of the variable",
+                                "default": "",
+                                "examples": [
+                                    "temperature"
+                                ]
+                            },
+                            "mapping": {
+                                "$id": "#/properties/inputs/items/anyOf/0/properties/mapping",
+                                "type": "string",
+                                "title": "databusTopic",
+                                "description": "Topic associated with the variable on Databus",
+                                "default": "",
+                                "examples": [
+                                    "ie/d/j/simatic/v1/s7c1/dp/r/BozokiAir/default:BozokiAir_DB_temperature"
+                                ]
+                            },
+                            "type": {
+                                "$id": "#/properties/inputs/items/anyOf/0/properties/type",
+                                "type": "string",
+                                "title": "variable type",
+                                "description": "Type of the variable",
+                                "default": "",
+                                "examples": [
+                                    "Real","Integer", "String"
+                                ]
+                            }
+                        },
+                        "additionalProperties": true
+                    }
+                ]
+            }
+        }
+    },
+    "additionalProperties": true
+}