simaticai 2.4.0__tar.gz

simaticai-2.4.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.1
+Name: simaticai
+Version: 2.4.0
+Summary: Software Development Kit for Industrial AI
+License: MIT
+Author: Siemens AG
+Requires-Python: >=3.10.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+
+# AI Software Development Kit
+
+AI Software Development Kit is a Python library that allows you to create, package, and test AI inference pipelines for the
+AI Inference Server. The AI SDK is accompanied by project templates that provide notebook-based workflows for training models,
+packaging them for deployment and testing these packages.
+
+Some of the AI SDK functionalities require pip version 21.3.1 or greater, so installing the library will upgrade your pip in the given Python environment.
+

simaticai-2.4.0/README.md

@@ -0,0 +1,7 @@
+# AI Software Development Kit
+
+AI Software Development Kit is a Python library that allows you to create, package, and test AI inference pipelines for the
+AI Inference Server. The AI SDK is accompanied by project templates that provide notebook-based workflows for training models,
+packaging them for deployment and testing these packages.
+
+Some of the AI SDK functionalities require pip version 21.3.1 or greater, so installing the library will upgrade your pip in the given Python environment.

simaticai-2.4.0/pyproject.toml

@@ -0,0 +1,102 @@
+[project]
+name = "simaticai"
+version = "2.4.0"
+
+dependencies = [
+    "joblib (>=1.5.1,<2.0.0)",
+    "jsonschema (>=4.0.1,<5.0.0)",
+    "markuppy (>=1.14,<2.0)",
+    "parsley (==1.3)",
+    "pip (>=25.1.1,<26.0.0)",
+    "opencv-python-headless (>=4.11.0.86,<5.0.0.0)",
+    "protobuf (>=6.31.0,<7.0.0)",
+    "pyyaml (>=6.0.1,<7.0.0)",
+    "requests (>=2.32.3,<3.0.0)",
+    "onnx (>=1.18.0,<2.0.0)",
+    "onnxruntime (>=1.22.0,<2.0.0)",
+    "idna (>=3.10,<4.0)",
+    "wheel (>=0.45.1,<0.46.0)"
+]
+
+[project.urls]
+Homepage = "https://github.com/industrial-edge/ai-sdk"
+Documentation = "https://github.com/industrial-edge/ai-sdk-tutorials"
+Repository = "https://github.com/industrial-edge/ai-sdk.git"
+Issues = "https://github.com/industrial-edge/ai-sdk/issues"
+Changelog = "https://github.com/industrial-edge/ai-sdk/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["poetry-core<=1.8.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+name = "simaticai"
+version = "2.4.0"
+description = "Software Development Kit for Industrial AI"
+authors = ["Siemens AG"]
+
+license = "MIT"
+readme = "README.md"
+
+include = ["simaticai/data/**/*"]
+packages = [{include = "simaticai"}]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10.0"
+
+[tool.poetry.group.dev.dependencies]
+autopep8 = "^1.6.0"
+cloudpickle = "^2.2.1"
+flake8 = "^4.0.1"
+importlib-metadata = "^4.4.0"
+pandas = "^1.5.3"
+portray = "1.8.0"
+pyarrow = "14.0.1"
+pytest = "^8.2.0"
+pytest-cov = "^5.0.0"
+pytest-html = "^4.1.1"
+pytest-httpserver = "^1.0.10"
+requests = "^2.31.0"
+scikit-learn = "^1.0.2"
+mkdocs-material = "8.5.0"
+packaging = "^23.0"
+
+[[tool.poetry.source]]
+name = "testpypi"
+url = "https://test.pypi.org/legacy/"
+priority = "supplemental"
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = ["test"]
+log_cli = true
+log_level = "INFO"
+markers = [
+    "integration: mark tests as integration tests",
+    "feature: mark tests as feature tests"
+]
+
+[tool.portray]
+overwrite = true
+output_dir = "dist/documentation"
+
+[tool.portray.mkdocs]
+copyright = "Copyright (C) Siemens AG 2021. All Rights Reserved."
+repo_url = ""
+repo_name = ""
+site_name = "AI Software Development Kit"
+edit_uri = ""
+use_directory_urls = false
+extra_css = [ "styles.css" ]
+
+[tool.portray.mkdocs.theme]
+name = "material"
+custom_dir = 'css'
+logo = 'Sie_logo_white.svg'
+favicon = 'favicon.ico'
+include_search_page = false
+search_index_only = 'false'

simaticai-2.4.0/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-2.4.0/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-2.4.0/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-2.4.0/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-2.4.0/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
+}