Skip to content

Commit f927767

Browse files
committed
More editorial changes covering the whole repo
Signed-off-by: M Q <mingmelvinq@nvidia.com>
1 parent 3173303 commit f927767

File tree

14 files changed

+26
-26
lines changed

14 files changed

+26
-26
lines changed

docs/_static/custom.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ blockquote p {
107107
}
108108

109109
/* Mermaid
110-
to avoid the lable text being cut off
110+
to avoid the label text being cut off
111111
*/
112112
.edgeTerminals {
113113
font-size: 9px !important;

docs/source/developing_with_sdk/packaging_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It is required that the application configuration yaml file as well as the depen
1313
### Basic Usage of MONAI Application Packager
1414

1515
```bash
16-
monai-deploy package <APP_PATH> --config <COMFIG> --tag <TAG> --platform <x64-workstation> [--models <MODEL_PATH>] [--log-level <LEVEL>] [-h]
16+
monai-deploy package <APP_PATH> --config <CONFIG> --tag <TAG> --platform <x64-workstation> [--models <MODEL_PATH>] [--log-level <LEVEL>] [-h]
1717
```
1818

1919
#### Required Arguments

docs/source/getting_started/tutorials/mednist_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jupyter-lab
4242
<div style="text-align: center;">
4343
<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>
4444
45-
<p>Video may show the use of previous SDK verson.</p>
45+
<p>Video may show the use of previous SDK version.</p>
4646
</div>
4747
```
4848

docs/source/getting_started/tutorials/monai_bundle_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jupyter-lab
3232
<div style="text-align: center;">
3333
<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>
3434
35-
<p>Video may show the use of previous SDK verson.</p>
35+
<p>Video may show the use of previous SDK version.</p>
3636
</div>
3737
```
3838

docs/source/release_notes/v0.3.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This operator uses [Clara Viz](https://pypi.org/project/clara-viz/) to provide i
1616

1717
### STL Surface Mesh Conversion Operator
1818

19-
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.
19+
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.
2020

2121
## What's fixed/updated
2222

docs/source/release_notes/v0.4.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
The new operator, `MONAI Bundle Inference Operator`, is intended to automate the inference with a MONAI Bundle in TorchScript with the following functionalities:
1111
- Parse the model metadata and extra configuration data in the TorchScript file
12-
- Instanciate MONAI transforms and inferer objects per bundle configuration data
12+
- Instantiate MONAI transforms and inferer objects per bundle configuration data
1313
- Convert input/output of the operator to and from model network input
1414
- Support named model and can be used in a multi-model application
1515

docs/source/release_notes/v0.5.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- 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
88
- Generated DICOM instance file names are now based on the SOP instance UID
99
- Support DICOM instance level attribute matching in the DICOM Series Selection Operator
10-
- 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
10+
- 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
1111
- Tutorials, in Jupyter notebooks, are re-organized and updated
1212
- Reference added for <a href="https://github.com/Project-MONAI/monai-deploy/releases">MONAI Deploy Express</a> for hosting MAPs in development environments
1313
- Removed is the reference to the deprecated MONAI Inference Service

docs/srs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ The SDK shall allow the packaging of the application in a standardized format so
521521

522522
### Background
523523

524-
Please refer to [MONAI Application Packge Spec](https://github.com/Project-MONAI/monai-deploy-experimental/blob/main/guidelines/monai-application-package.md)for details.
524+
Please refer to [MONAI Application Package Spec](https://github.com/Project-MONAI/monai-deploy-experimental/blob/main/guidelines/monai-application-package.md)for details.
525525

526526
### Verification Strategy
527527

monai/deploy/core/domain/dicom_series.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ def get_sop_instances(self):
5151
return self._sop_instances
5252

5353
# 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:
5555
# Keyword: SeriesInstanceUID, Tag: (0020,000E)
5656
# Keyword: Modality, Tag: (0008,0060)
5757
#

monai/deploy/core/domain/dicom_sop_instance.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828

2929
class DICOMSOPInstance(Domain):
30-
"""This class representes a SOP Instance.
30+
"""This class represents a SOP Instance.
3131
3232
An attribute can be looked up with a slice ([group_number, element number]).
3333
"""

monai/deploy/core/domain/dicom_study.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def get_all_series(self):
3535
return list(self._series_dict.values())
3636

3737
# Properties named after DICOM Study module attribute keywords
38-
# There is only one required (Type 1) attrbute for a study:
38+
# There is only one required (Type 1) attribute for a study:
3939
# Keyword: StudyInstanceUID, Tag: (0020,000D)
4040
#
4141
@property

monai/deploy/utils/importutil.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def get_docstring(cls: Type) -> str:
2727
"""Get docstring of a class.
2828
2929
Tries to get docstring from class itself, from its __doc__.
30-
It trims the preceeding whitespace from docstring.
30+
It trims the preceding whitespace from docstring.
3131
If __doc__ is not available, it returns empty string.
3232
3333
Args:

notebooks/tutorials/02_mednist_app.ipynb

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@
416416
},
417417
{
418418
"cell_type": "code",
419-
"execution_count": 13,
419+
"execution_count": null,
420420
"metadata": {},
421421
"outputs": [
422422
{
@@ -439,7 +439,7 @@
439439
"# Choose a file as test input\n",
440440
"test_input_path = image_files[0][0]\n",
441441
"!rm -rf {input_folder} && mkdir -p {input_folder} && cp {test_input_path} {input_folder} && ls {input_folder}\n",
442-
"# Need to copy the model file to its own clean subfolder for pacakging, to workaround an issue in the Packager\n",
442+
"# Need to copy the model file to its own clean subfolder for packaging, to workaround an issue in the Packager\n",
443443
"!rm -rf {models_folder} && mkdir -p {models_folder}/model && cp classifier.zip {models_folder}/model && ls {models_folder}/model\n",
444444
"\n",
445445
"%env HOLOSCAN_INPUT_PATH {input_folder}\n",
@@ -558,7 +558,7 @@
558558
},
559559
{
560560
"cell_type": "code",
561-
"execution_count": 16,
561+
"execution_count": null,
562562
"metadata": {},
563563
"outputs": [],
564564
"source": [
@@ -579,7 +579,7 @@
579579
"\n",
580580
" def __init__(\n",
581581
" self,\n",
582-
" frament: Fragment,\n",
582+
" fragment: Fragment,\n",
583583
" *args,\n",
584584
" app_context: AppContext,\n",
585585
" model_name: Optional[str] = \"\",\n",
@@ -606,7 +606,7 @@
606606
" # The name of the optional input port for passing data to override the output folder path.\n",
607607
" self.input_name_output_folder = \"output_folder\"\n",
608608
"\n",
609-
" # The output folder set on the object can be overriden at each compute by data in the optional named input\n",
609+
" # The output folder set on the object can be overridden at each compute by data in the optional named input\n",
610610
" self.output_folder = output_folder\n",
611611
"\n",
612612
" # Need the name when there are multiple models loaded\n",
@@ -617,7 +617,7 @@
617617
" self.model = self._get_model(self.app_context, self.model_path, self._model_name)\n",
618618
"\n",
619619
" # This needs to be at the end of the constructor.\n",
620-
" super().__init__(frament, *args, **kwargs)\n",
620+
" super().__init__(fragment, *args, **kwargs)\n",
621621
"\n",
622622
" def _get_model(self, app_context: AppContext, model_path: Path, model_name: str):\n",
623623
" \"\"\"Load the model with the given name from context or model path\n",
@@ -839,7 +839,7 @@
839839
},
840840
{
841841
"cell_type": "code",
842-
"execution_count": 21,
842+
"execution_count": null,
843843
"metadata": {},
844844
"outputs": [
845845
{
@@ -954,7 +954,7 @@
954954
"\n",
955955
" def __init__(\n",
956956
" self,\n",
957-
" frament: Fragment,\n",
957+
" fragment: Fragment,\n",
958958
" *args,\n",
959959
" app_context: AppContext,\n",
960960
" model_name: Optional[str] = \"\",\n",
@@ -981,7 +981,7 @@
981981
" # The name of the optional input port for passing data to override the output folder path.\n",
982982
" self.input_name_output_folder = \"output_folder\"\n",
983983
"\n",
984-
" # The output folder set on the object can be overriden at each compute by data in the optional named input\n",
984+
" # The output folder set on the object can be overridden at each compute by data in the optional named input\n",
985985
" self.output_folder = output_folder\n",
986986
"\n",
987987
" # Need the name when there are multiple models loaded\n",
@@ -992,7 +992,7 @@
992992
" self.model = self._get_model(self.app_context, self.model_path, self._model_name)\n",
993993
"\n",
994994
" # This needs to be at the end of the constructor.\n",
995-
" super().__init__(frament, *args, **kwargs)\n",
995+
" super().__init__(fragment, *args, **kwargs)\n",
996996
"\n",
997997
" def _get_model(self, app_context: AppContext, model_path: Path, model_name: str):\n",
998998
" \"\"\"Load the model with the given name from context or model path\n",

run

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -407,7 +407,7 @@ install_edit_mode() {
407407

408408
setup_desc() { c_echo 'Setup development environment
409409
410-
Arguements:
410+
Arguments:
411411
$1 - configuration (default: "dev")
412412
'
413413
}
@@ -468,7 +468,7 @@ build_desc() { c_echo 'Build distribution package
468468
Build a distribution package for this SDK using
469469
"build" (https://pypa-build.readthedocs.io/en/stable/index.html).
470470
471-
Arguements:
471+
Arguments:
472472
$1 - destination folder (default: ${TOP}/dist)
473473
'
474474
}
@@ -970,7 +970,7 @@ setup_gen_docs() {
970970

971971
gen_docs_desc() { c_echo 'Generate documents
972972
973-
Generated docs would be avaialable at ${TOP}/dist/docs.
973+
Generated docs would be available at ${TOP}/dist/docs.
974974
975975
Arguments:
976976
$1 - output folder path (html docs)
@@ -1012,7 +1012,7 @@ gen_docs_dev_desc() { c_echo 'Generate documents (with dev-server)
10121012
10131013
Launch dev-server for sphinx.
10141014
1015-
Generated docs would be avaialable at ${TOP}/dist/docs.
1015+
Generated docs would be available at ${TOP}/dist/docs.
10161016
10171017
Arguments:
10181018
-p <port> - port number

0 commit comments

Comments
 (0)