More editorial changes covering the whole repo

MMelQin · MMelQin · commit f927767574d9 · 2025-02-12T17:20:14.000-08:00
Signed-off-by: M Q &lt;mingmelvinq@nvidia.com&gt;
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -107,7 +107,7 @@ blockquote p {
 }
 
 /* Mermaid
-to avoid the lable text being cut off
+to avoid the label text being cut off
 */
 .edgeTerminals {
     font-size: 9px !important;
diff --git a/docs/source/developing_with_sdk/packaging_app.md b/docs/source/developing_with_sdk/packaging_app.md
@@ -13,7 +13,7 @@ It is required that the application configuration yaml file as well as the depen
 ### Basic Usage of MONAI Application Packager
 
 ```bash
-monai-deploy package <APP_PATH> --config <COMFIG> --tag <TAG> --platform <x64-workstation> [--models <MODEL_PATH>] [--log-level <LEVEL>] [-h]
+monai-deploy package <APP_PATH> --config <CONFIG> --tag <TAG> --platform <x64-workstation> [--models <MODEL_PATH>] [--log-level <LEVEL>] [-h]
 ```
 
 #### Required Arguments
diff --git a/docs/source/getting_started/tutorials/mednist_app.md b/docs/source/getting_started/tutorials/mednist_app.md
@@ -42,7 +42,7 @@ jupyter-lab
 <div style="text-align: center;">
     <iframe width="560" height="315" src="https://www.youtube.com/embed/WwjilJFHuU4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
-    <p>Video may show the use of previous SDK verson.</p>
+    <p>Video may show the use of previous SDK version.</p>
 </div>
 ```
 
diff --git a/docs/source/getting_started/tutorials/monai_bundle_app.md b/docs/source/getting_started/tutorials/monai_bundle_app.md
@@ -32,7 +32,7 @@ jupyter-lab
 <div style="text-align: center;">
     <iframe width="560" height="315" src="https://www.youtube.com/embed/nivgfD4pwWE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
 
-    <p>Video may show the use of previous SDK verson.</p>
+    <p>Video may show the use of previous SDK version.</p>
 </div>
 ```
 
diff --git a/docs/source/release_notes/v0.3.0.md b/docs/source/release_notes/v0.3.0.md
@@ -16,7 +16,7 @@ This operator uses [Clara Viz](https://pypi.org/project/clara-viz/) to provide i
 
 ### STL Surface Mesh Conversion Operator
 
-This operator converts a volume image to surface mesh, in [STL file format](https://en.wikipedia.org/wiki/STL_(file_format)). Its API allows the client to control if smoothing needs to be applied, and if only keeping the largest connected component; the latter is useful when muliple disjoint segments are in a volume image, and the application needs to control if all or only the largest to be included in the output.
+This operator converts a volume image to surface mesh, in [STL file format](https://en.wikipedia.org/wiki/STL_(file_format)). Its API allows the client to control if smoothing needs to be applied, and if only keeping the largest connected component; the latter is useful when multiple disjoint segments are in a volume image, and the application needs to control if all or only the largest to be included in the output.
 
 ## What's fixed/updated
 
diff --git a/docs/source/release_notes/v0.4.0.md b/docs/source/release_notes/v0.4.0.md
@@ -9,7 +9,7 @@
 
 The new operator, `MONAI Bundle Inference Operator`, is intended to automate the inference with a MONAI Bundle in TorchScript with the following functionalities:
 - Parse the model metadata and extra configuration data in the TorchScript file
-- Instanciate MONAI transforms and inferer objects per bundle configuration data
+- Instantiate MONAI transforms and inferer objects per bundle configuration data
 - Convert input/output of the operator to and from model network input
 - Support named model and can be used in a multi-model application
 
diff --git a/docs/source/release_notes/v0.5.0.md b/docs/source/release_notes/v0.5.0.md
@@ -7,7 +7,7 @@
 - Generated DICOM instances as AI evidence now have the attribute <a href="https://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_C.12.html#table_C.12-1">(0008,0201) Timezone Offset From UTC</a>, in addition to the DICOM date and time which are set with values from the underlying operating system. The OS is expected to be synchronized with a known good timing source and have the correct timezone setting
 - Generated DICOM instance file names are now based on the SOP instance UID
 - Support DICOM instance level attribute matching in the DICOM Series Selection Operator
-- Operators and example applications are verified to be re-runable without needing to reinitialize the application object or re-load the AI model network. This will allow a main function or an external script to instantiate the application object once and use it to process multiple discreet inputs, either in a batch processing mode or in a long running service
+- Operators and example applications are verified to be re-runable without needing to reinitialize the application object or re-load the AI model network. This will allow a main function or an external script to instantiate the application object once and use it to process multiple discrete inputs, either in a batch processing mode or in a long running service
 - Tutorials, in Jupyter notebooks, are re-organized and updated
 - Reference added for <a href="https://github.com/Project-MONAI/monai-deploy/releases">MONAI Deploy Express</a> for hosting MAPs in development environments
 - Removed is the reference to the deprecated MONAI Inference Service
diff --git a/docs/srs.md b/docs/srs.md
@@ -521,7 +521,7 @@ The SDK shall allow the packaging of the application in a standardized format so
 
 ### Background
 
-Please refer to [MONAI Application Packge Spec](https://github.com/Project-MONAI/monai-deploy-experimental/blob/main/guidelines/monai-application-package.md)for details.
+Please refer to [MONAI Application Package Spec](https://github.com/Project-MONAI/monai-deploy-experimental/blob/main/guidelines/monai-application-package.md)for details.
 
 ### Verification Strategy
 
diff --git a/monai/deploy/core/domain/dicom_series.py b/monai/deploy/core/domain/dicom_series.py
@@ -51,7 +51,7 @@ def get_sop_instances(self):
         return self._sop_instances
 
     # Properties named after DICOM Series module attribute keywords
-    # There are two required (Type 1) attrbutes for a series:
+    # There are two required (Type 1) attributes for a series:
     #     Keyword: SeriesInstanceUID, Tag: (0020,000E)
     #     Keyword: Modality, Tag: (0008,0060)
     #
diff --git a/monai/deploy/core/domain/dicom_sop_instance.py b/monai/deploy/core/domain/dicom_sop_instance.py
@@ -27,7 +27,7 @@
 
 
 class DICOMSOPInstance(Domain):
-    """This class representes a SOP Instance.
+    """This class represents a SOP Instance.
 
     An attribute can be looked up with a slice ([group_number, element number]).
     """
diff --git a/monai/deploy/core/domain/dicom_study.py b/monai/deploy/core/domain/dicom_study.py
@@ -35,7 +35,7 @@ def get_all_series(self):
         return list(self._series_dict.values())
 
     # Properties named after DICOM Study module attribute keywords
-    # There is only one required (Type 1) attrbute for a study:
+    # There is only one required (Type 1) attribute for a study:
     #     Keyword: StudyInstanceUID, Tag: (0020,000D)
     #
     @property
diff --git a/monai/deploy/utils/importutil.py b/monai/deploy/utils/importutil.py
@@ -27,7 +27,7 @@ def get_docstring(cls: Type) -> str:
     """Get docstring of a class.
 
     Tries to get docstring from class itself, from its __doc__.
-    It trims the preceeding whitespace from docstring.
+    It trims the preceding whitespace from docstring.
     If __doc__ is not available, it returns empty string.
 
     Args:
diff --git a/notebooks/tutorials/02_mednist_app.ipynb b/notebooks/tutorials/02_mednist_app.ipynb
@@ -416,7 +416,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -439,7 +439,7 @@
     "# Choose a file as test input\n",
     "test_input_path = image_files[0][0]\n",
     "!rm -rf {input_folder} && mkdir -p {input_folder} && cp {test_input_path} {input_folder} && ls {input_folder}\n",
-    "# Need to copy the model file to its own clean subfolder for pacakging, to workaround an issue in the Packager\n",
+    "# Need to copy the model file to its own clean subfolder for packaging, to workaround an issue in the Packager\n",
     "!rm -rf {models_folder} && mkdir -p {models_folder}/model && cp classifier.zip {models_folder}/model && ls {models_folder}/model\n",
     "\n",
     "%env HOLOSCAN_INPUT_PATH {input_folder}\n",
@@ -558,7 +558,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -579,7 +579,7 @@
     "\n",
     "    def __init__(\n",
     "        self,\n",
-    "        frament: Fragment,\n",
+    "        fragment: Fragment,\n",
     "        *args,\n",
     "        app_context: AppContext,\n",
     "        model_name: Optional[str] = \"\",\n",
@@ -606,7 +606,7 @@
     "        # The name of the optional input port for passing data to override the output folder path.\n",
     "        self.input_name_output_folder = \"output_folder\"\n",
     "\n",
-    "        # The output folder set on the object can be overriden at each compute by data in the optional named input\n",
+    "        # The output folder set on the object can be overridden at each compute by data in the optional named input\n",
     "        self.output_folder = output_folder\n",
     "\n",
     "        # Need the name when there are multiple models loaded\n",
@@ -617,7 +617,7 @@
     "        self.model = self._get_model(self.app_context, self.model_path, self._model_name)\n",
     "\n",
     "        # This needs to be at the end of the constructor.\n",
-    "        super().__init__(frament, *args, **kwargs)\n",
+    "        super().__init__(fragment, *args, **kwargs)\n",
     "\n",
     "    def _get_model(self, app_context: AppContext, model_path: Path, model_name: str):\n",
     "        \"\"\"Load the model with the given name from context or model path\n",
@@ -839,7 +839,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 21,
+   "execution_count": null,
    "metadata": {},
    "outputs": [
     {
@@ -954,7 +954,7 @@
     "\n",
     "    def __init__(\n",
     "        self,\n",
-    "        frament: Fragment,\n",
+    "        fragment: Fragment,\n",
     "        *args,\n",
     "        app_context: AppContext,\n",
     "        model_name: Optional[str] = \"\",\n",
@@ -981,7 +981,7 @@
     "        # The name of the optional input port for passing data to override the output folder path.\n",
     "        self.input_name_output_folder = \"output_folder\"\n",
     "\n",
-    "        # The output folder set on the object can be overriden at each compute by data in the optional named input\n",
+    "        # The output folder set on the object can be overridden at each compute by data in the optional named input\n",
     "        self.output_folder = output_folder\n",
     "\n",
     "        # Need the name when there are multiple models loaded\n",
@@ -992,7 +992,7 @@
     "        self.model = self._get_model(self.app_context, self.model_path, self._model_name)\n",
     "\n",
     "        # This needs to be at the end of the constructor.\n",
-    "        super().__init__(frament, *args, **kwargs)\n",
+    "        super().__init__(fragment, *args, **kwargs)\n",
     "\n",
     "    def _get_model(self, app_context: AppContext, model_path: Path, model_name: str):\n",
     "        \"\"\"Load the model with the given name from context or model path\n",
diff --git a/run b/run
@@ -407,7 +407,7 @@ install_edit_mode() {
 
 setup_desc() { c_echo 'Setup development environment
 
-Arguements:
+Arguments:
   $1 - configuration (default: "dev")
 '
 }
@@ -468,7 +468,7 @@ build_desc() { c_echo 'Build distribution package
 Build a distribution package for this SDK using
 "build" (https://pypa-build.readthedocs.io/en/stable/index.html).
 
-Arguements:
+Arguments:
   $1 - destination folder (default: ${TOP}/dist)
 '
 }
@@ -970,7 +970,7 @@ setup_gen_docs() {
 
 gen_docs_desc() { c_echo 'Generate documents
 
-Generated docs would be avaialable at ${TOP}/dist/docs.
+Generated docs would be available at ${TOP}/dist/docs.
 
 Arguments:
   $1 - output folder path (html docs)
@@ -1012,7 +1012,7 @@ gen_docs_dev_desc() { c_echo 'Generate documents (with dev-server)
 
 Launch dev-server for sphinx.
 
-Generated docs would be avaialable at ${TOP}/dist/docs.
+Generated docs would be available at ${TOP}/dist/docs.
 
 Arguments:
   -p <port> - port number

Original file line number	Diff line number	Diff line change
`@@ -107,7 +107,7 @@ blockquote p {`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`/* Mermaid`
`110`		`-to avoid the lable text being cut off`
	`110`	`+to avoid the label text being cut off`
`111`	`111`	`*/`
`112`	`112`	`.edgeTerminals {`
`113`	`113`	`font-size: 9px !important;`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ def get_sop_instances(self):`
`51`	`51`	`return self._sop_instances`
`52`	`52`
`53`	`53`	`# Properties named after DICOM Series module attribute keywords`
`54`		`- # There are two required (Type 1) attrbutes for a series:`
	`54`	`+ # There are two required (Type 1) attributes for a series:`
`55`	`55`	`# Keyword: SeriesInstanceUID, Tag: (0020,000E)`
`56`	`56`	`# Keyword: Modality, Tag: (0008,0060)`
`57`	`57`	`#`