@cornerstonejs/ai 2.10.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Open Health Imaging Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# Cornerstone AI Client Package
+
+This package provides AI interfaces for use with Cornerstone in client-side applications. It is designed to support the use of ONNX models, ensuring a clean separation between server-side AI processing and client-specific functionalities tied to Cornerstone.
+
+## Key Features
+
+- **ONNX Runtime Web Integration**: The package leverages the ONNX Runtime Web library, enabling AI models to run directly in the browser without relying on server-side execution.
+- **Initial Model - Segment Anything Model (SAM)**: Our first supported model is the Segment Anything Model (SAM) https://segment-anything.com/, designed for segmentation tasks.
+
+## Getting Started
+
+### Running the Example
+
+To see the package in action with the Segment Anything Model, use the following command:
+
+```bash
+yarn run example segmentAnythingClientSide
+```
+
+This will load the SAM model in the browser and allow you to perform segmentation tasks on images.
+
+### Model Files
+
+The package does not include model binaries due to their size and to give users the flexibility to use their own models. You can download pre-trained model binaries from the following links:
+
+Base model (vit_b) - 178 MB compressed
+
+- https://ohif-assets-new.s3.us-east-1.amazonaws.com/SAM/sam_b.zip
+
+Large model (vit_l) - 1.16 GB compressed
+
+- https://ohif-assets-new.s3.us-east-1.amazonaws.com/SAM/sam_l.zip
+
+Huge model (vit_h) - 2.38 GB compressed
+
+- https://ohif-assets-new.s3.us-east-1.amazonaws.com/SAM/sam_h.zip
+
+For the examples we are using the model url and fetch it from the web. If you see in example code we have:
+
+
+#### URL to the model files
+
+```js
+const models = {
+  sam_b: [
+    {
+      name: 'sam-b-encoder',
+      url: 'https://huggingface.co/schmuell/sam-b-fp16/resolve/main/sam_vit_b_01ec64.encoder-fp16.onnx',
+      size: 180,
+      key: 'encoder',
+    },
+    {
+      name: 'sam-b-decoder',
+      url: 'https://huggingface.co/schmuell/sam-b-fp16/resolve/main/sam_vit_b_01ec64.decoder.onnx',
+      size: 17,
+      key: 'decoder',
+    },
+  ],
+};
+
+const ai = new ONNXSegmentationController({
+  listeners: [mlLogger],
+  models,
+  modelName: 'sam_b',
+});
+```
+
+which gives the url to the model files.
+
+#### Models in binary
+
+You can download the model files and use them offline by moving them to the public folder.
+
+In Webpack you can add the model files to the public folder like this
+
+```js
+new CopyPlugin({
+  patterns: [
+    {
+      from:
+        '../../../externals/sam_l',
+      to: '${destPath.replace(/\\/g, '/')}/sam_l',
+    },
+    {
+      from:
+        '../../../externals/sam_h',
+      to: '${destPath.replace(/\\/g, '/')}/sam_h',
+    },
+  ],
+}),
+```
+
+, other build systems might have a different way to do this.

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@cornerstonejs/ai",
+  "version": "2.10.0",
+  "description": "AI and ML Interfaces for Cornerstone3D",
+  "files": [
+    "dist"
+  ],
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "directories": {
+    "build": "dist"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "types": "./dist/esm/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "jest --testTimeout 60000",
+    "clean": "rimraf dist",
+    "build": "yarn run build:esm",
+    "build:esm": "tsc --project ./tsconfig.json",
+    "build:esm:watch": "tsc --project ./tsconfig.json --watch",
+    "dev": "tsc --project ./tsconfig.json --watch",
+    "build:all": "yarn run build:esm",
+    "build:update-api": "yarn run build:esm && api-extractor run --local",
+    "start": "tsc --project ./tsconfig.json --watch",
+    "format": "prettier --write 'src/**/*.js' 'test/**/*.js'",
+    "lint": "eslint --fix ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dcmjs-org/dcmjs.git"
+  },
+  "author": "@cornerstonejs",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/cornerstonejs/cornerstone3D/issues"
+  },
+  "homepage": "https://github.com/cornerstonejs/cornerstone3D/blob/main/packages/ai/README.md",
+  "dependencies": {
+    "@babel/runtime-corejs2": "^7.17.8",
+    "buffer": "^6.0.3",
+    "dcmjs": "^0.29.8",
+    "gl-matrix": "^3.4.3",
+    "lodash.clonedeep": "^4.5.0",
+    "ndarray": "^1.0.19",
+    "onnxruntime-common": "1.17.1",
+    "onnxruntime-web": "1.17.1"
+  },
+  "peerDependencies": {
+    "@cornerstonejs/core": "^2.10.0",
+    "@cornerstonejs/tools": "^2.10.0"
+  },
+  "gitHead": "aab86e3f13a86bcd2d975a4cfbdf7eee7fa1627a"
+}