Version 0.6.0

What’s new in 0.6.0

  • App SDK has been migrated to be dependent on NVIDIA Holoscan SDK, latest version v0.6. As such, breaking changes are introduced in this version of the App SDK.

  • All example applications and Jupyter Notebooks are updated to be compatible with the new version of App SDK.

Key changes and migration guide

  • In App SDK core module, monai.deploy.core, instead of through a wrapper layer, Holoscan SDK core sub modules are all directly imported and exposed undermonai.deploy.core, mixed in with the ones original to the App SDK. The same also applies to those modules, e.g., conditions, executors, graphs, logger, and resources. As such, the Modudle API documentation may show a mixture of monai.deploy and holoscan.

  • For monai.deploy.operators, Holoscan SDK built-in operators are selectively imported and exposed, with the main reason being to avoid introducing extra dependencies on system packages. All of the original and existing App SDK built-in operators are still present and migrated to be based on Holoscan SDK base operator class.

  • Python decorator support for Application and Operator class is absent in this release, so alternative approaches must be used

    • Operator input(s) and output(s) now must be defined in the setup() method of this class

    • Application and Operator cannot decorate or serve out the resource and package dependencies, which are required when packaging the application into MONAI Application Package. So the application developer must now provide the Python package requirement file and application configuration file when creating a MAP

  • Derived Operator class must first assign its attributes before calling the constructor of the base Operator.

  • Application’s run() method can no longer pass the file I/O paths, e.g. input, output, and models, to the execution context of each operator when its compute() method is called. For operators depending on them, the I/O paths need to be passed in as arguments in the constructor.

  • App SDK CLI, monai-deploy, no longer support exec sub-command. However, when directly running the application with Python, command line options for --input, --output, and --model, are supported if the application make use of the Application’s class method, init_app_context(argv).

  • App SDK CLI packaging command, monai-deploy package, requires additional command line parameters, namely, application configuration yaml file, Python requirements file, and the platform configuration (as it supports both x86-64 and ARMv8 AArch64 targets). Details can be found in the tutorials and Users Guide.

Please also see the closed issues on Github and the closed pull requests on Github.

Known issues

  • When passing a model file to the packager command, monai-deploy package, its whole parent folder content is copied to the container image’s models folder, which can cause runtime application failure if unexpected contents are in the source folder. So, please ensure only the model file itself is in the source folder. This issue is scheduled to be fixed in the next release. For applications with multiple models, the requirement on folder structure remain the same.

Additional information

Please visit GETTING STARTED guide and follow the tutorials.

You can learn more about SDK usage through DEVELOPING WITH SDK.

Please let us know how you like it and what could be improved by submitting an issue or asking questions

Version 1.0.0 (April 2024) Version 0.5.1 (July 12, 2023)