ci: add codespell spell-check workflow and fix typos in core

Add .github/workflows/spell-check.yml running codespell on every push
and pull_request, and a .codespellrc limiting the check to core/.

Fix all typos caught by the new check:
- Deafult -> Default (log.py)
- caculate -> calculate (federated_class_incremental_learning.py)
- enviroment -> environment (simulation.py, simulation_system_admin.py)
- segmantation -> segmentation (dataset.py)

Fixes #232

Signed-off-by: dev-aditya-hub <premjadhvar95@gmail.com>

Author: dev-aditya-hub

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+# examples/ and docs/proposals/ contain pre-existing issues from many
+# contributors; they are tracked separately. CI focuses on core/ only.
+skip = *.pyc,__pycache__,*.egg-info,.git

.github/workflows/spell-check.yml

@@ -0,0 +1,22 @@
+name: Spell Check
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  codespell:
+    runs-on: ubuntu-22.04
+    name: codespell
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.9"
+      - name: Install codespell
+        run: python -m pip install codespell
+      - name: Run codespell
+        run: codespell --config .codespellrc core

core/common/log.py

@@ -21,7 +21,7 @@
 # pylint: disable=too-few-public-methods
 class Logger:
     """
-    Deafult logger in ianvs
+    Default logger in ianvs
     Args:
         name(str) : Logger name, default is 'ianvs'
     """

core/testcasecontroller/algorithm/paradigm/federated_learning/federated_class_incremental_learning.py

@@ -249,7 +249,7 @@ def evaluation(self, testdataset_files, incremental_round):
         if isinstance(testdataset_files, str):
             testdataset_files = [testdataset_files]
         job = self.get_global_model()
-        # caculate the seen class accuracy
+        # calculate the seen class accuracy
         old_class_acc_list = (
             []
         )  # for current round [class_0: acc_0, class_1: acc1, ....]
@@ -272,7 +272,7 @@ def evaluation(self, testdataset_files, incremental_round):
         self.system_metric_info[SystemMetricType.TASK_AVG_ACC.value]["accuracy"] = (
             np.mean(old_class_acc_list)
         )
-        # caculate the forget rate
+        # calculate the forget rate
         for i in range(len(old_class_acc_list)):
             max_acc_diff = 0
             for j in range(incremental_round):

core/testcasecontroller/simulation/simulation.py

@@ -18,7 +18,7 @@
 # pylint: disable=too-few-public-methods
 class Simulation:
     """
-    Simulation: The simulation enviroment, e.g. config of simulation.
+    Simulation: The simulation environment, e.g. config of simulation.
 
     Parameters
     ----------

core/testcasecontroller/simulation_system_admin/simulation_system_admin.py

@@ -135,9 +135,9 @@ def check_host_cpu():
         raise RuntimeError("The number os cpus is insufficient.")
 
 
-def check_host_enviroment():
+def check_host_environment():
     """
-    check the host enviroment, includes docker, kind, cpu and memory.
+    check the host environment, includes docker, kind, cpu and memory.
 
     """
     check_host_docker()
@@ -146,13 +146,13 @@ def check_host_enviroment():
     check_host_cpu()
 
 
-def build_simulation_enviroment(simulation):
+def build_simulation_environment(simulation):
     """
-    build a simulation enviroment
+    build a simulation environment
 
     """
 
-    check_host_enviroment()         # check the enviroment
+    check_host_environment()         # check the environment
 
     shell_cmd = "curl https://raw.githubusercontent.com/kubeedge/sedna\
 /master/scripts/installation/all-in-one.sh | " \
@@ -167,14 +167,14 @@ def build_simulation_enviroment(simulation):
 
     if build_simulation_env_ret.returncode == 0:
         LOGGER.info(
-            "Congratulation! The simulation enviroment build successful!")
+            "Congratulation! The simulation environment build successful!")
     else:
-        raise RuntimeError("The simulation enviroment build failed.")
+        raise RuntimeError("The simulation environment build failed.")
 
 
-def destory_simulation_enviroment(simulation):
+def destory_simulation_environment(simulation):
     """
-    build the simulation enviroment
+    build the simulation environment
 
     """
     shell_cmd = "curl https://raw.githubusercontent.com/kubeedge/sedna\

core/testenvmanager/dataset/dataset.py

@@ -228,7 +228,7 @@ def split_dataset(
                 output_dir=output_dir,
                 times=times,
             )
-        # add new splitting method for semantic segmantation
+        # add new splitting method for semantic segmentation
         if method == "city_splitting":
             return self._city_splitting(
                 dataset_url,