fix: typo in.md, .yaml, and .py files

[omkar-334]

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
To maintain readability and ease of access.

Which issue(s) this PR fixes:
#232.

Typos that I have not made changes to -

1. All the .md files in ./docs/proposals/
2. .py Function names
3. .yaml variable names

Procedure

1. pip install codespell
2. uv run codespell .
3. Manually inspect the typos detected (since they can be false, like rouge->rogue, etc)

cc @MooreZheng @hsj576 @AryanNanda17

[kubeedge-bot]

Welcome @omkar-334! It looks like this is your first PR to kubeedge/ianvs 🎉

[kubeedge-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: omkar-334
To complete the pull request process, please assign jaypume after the PR has been reviewed.
You can assign the PR to them by writing /assign @jaypume in a comment when ready.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[gemini-code-assist]

Summary of Changes

Hello @omkar-334, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a comprehensive cleanup effort, addressing a wide array of typos and minor formatting inconsistencies throughout the codebase and documentation. The primary goal is to improve the overall quality, readability, and maintainability of the project's assets, ensuring a more polished and professional user experience. These changes, while small individually, collectively contribute to a more robust and understandable project for both developers and users.

Highlights

• Documentation and Code Readability: Corrected numerous spelling and grammatical errors across Markdown (.md) and Python (.py) files to enhance clarity and professionalism. Common corrections include 'Detetion' to 'Detection', 'enviroment' to 'environment', 'bechmarking' to 'benchmarking', 'thresold' to 'threshold', and 'Initializating' to 'Initializing'.
• Consistency in Terminology: Standardized various terms such as 'Default' (from 'Deafult'), 'calculate' (from 'caculate'), 'beneficial' (from 'benefical'), 'Unsupported' (from 'unsupport'), 'dimensions' (from 'dimentions'), 'overlapped' (from 'overlaped'), 'accelerate' (from 'accelarate'), 'protocol' (from 'protocal'), 'response' (from 'reponse'), 'reproducible' (from 'reproducable'), and 'corresponding' (from 'cooresponding').
• Markdown Formatting Improvements: Added newlines and adjusted spacing in several Markdown files to improve the visual presentation and readability of headings, code blocks, and lists.
• Minor Code Refinements: Updated Python code to remove f-strings for simple print statements and corrected a function name from 'partiton' to 'partition' in a docstring, aligning with standard naming conventions.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• README.md
  • Corrected 'Detetion' to 'Detection' in multiple links and descriptions.
  • Corrected 'detetion' to 'detection' in example descriptions.
• core/common/log.py
  • Corrected typo 'Deafult' to 'Default' in Logger class docstring.
• core/testcasecontroller/algorithm/paradigm/federated_learning/federated_class_incremental_learning.py
  • Adjusted parameter formatting from '---------' to '----------'.
  • Capitalized the first letter of docstrings for 'get_task_size', 'split_label_unlabel_data', 'run', '_split_test_dataset', 'client_train', 'helper_function', and 'evaluation' methods.
  • Corrected 'caculate' to 'calculate' in comments.
• core/testcasecontroller/simulation/simulation.py
  • Capitalized the first letter of docstrings for '_parse_config' and '_check_fields' methods.
• core/testcasecontroller/simulation_system_admin/simulation_system_admin.py
  • Capitalized the first letter of docstrings for 'check_host_kind', 'get_host_free_memory_size', 'check_host_memory', 'get_host_number_of_cpus', 'check_host_cpu', 'check_host_enviroment', 'build_simulation_enviroment', and 'destory_simulation_enviroment' functions.
  • Corrected 'enviroment' to 'environment' in docstrings and log messages.
  • Improved readability of shell commands by adding parentheses for multi-line strings.
• core/testenvmanager/dataset/dataset.py
  • Corrected typo 'segmantation' to 'segmentation' in a comment.
• docs/guides/how-to-build-simulation-env.md
  • Corrected 'enviroment' to 'environment' in descriptions.
  • Corrected 'moudles' to 'modules'.
  • Corrected 'funcitons' to 'functions'.
• docs/guides/how-to-test-algorithms.md
  • Removed a redundant link for 'Details of Ianvs-MMLU-5-shot dataset'.
  • Corrected typo 'thresold' to 'threshold'.
  • Corrected typo 'Opitmal' to 'Optimal'.
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
  • Corrected typo 'absoulute' to 'absolute' in YAML comments.
  • Corrected typo 'reproducable' to 'reproducible' in YAML comments.
  • Corrected typo 'reponse' to 'response' in YAML comments.
  • Adjusted spacing around code blocks and lists for better readability.
• docs/user_interface/how-to-config-algorithm.md
  • Corrected typo 'Defalut' to 'Default' in parameter tables.
  • Corrected typo 'reproducable' to 'reproducible' in YAML comments.
  • Corrected typo 'reponse' to 'response' in YAML comments.
  • Added newlines for better formatting around headings and code blocks.
• docs/user_interface/how-to-config-benchmarkingjob.md
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
  • Corrected typo 'absoulute' to 'absolute' in YAML comments.
• examples/Cloud_Robotics/cloud-edge-collaborative-inference_bench/perception-reasoning/README.md
  • Added newlines for better readability around headings and lists.
  • Corrected typo 'instructure' to 'structure'.
  • Corrected typo 'resoning' to 'reasoning'.
  • Corrected typo 'viwe' to 'view' and 'Expalanation' to 'Explanation'.
  • Corrected typo 'dispacher' to 'dispatcher'.
  • Added newlines around code blocks and emphasized text.
• examples/Cloud_Robotics/cloud-edge-collaborative-inference_bench/perception-reasoning/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
  • Corrected typo 'absoulute' to 'absolute' in YAML comments.
• examples/Cloud_Robotics/singletask_learning_bench/Semantic_Segmentation/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/GovDoc2Poster/singletask_learning_bench/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/RoboDK Palletizing/singletask_learning_bench/testenv/map50.py
  • Corrected typo 'dimentions' to 'dimensions' in a comment.
• examples/RoboDK Palletizing/singletask_learning_bench/testenv/map90.py
  • Corrected typo 'dimentions' to 'dimensions' in a comment.
• examples/TAB/cloud_edge_collaborative_inference_bench/test_algorithms/edge_model/edge_model.py
  • Corrected typo 'unsupport' to 'Unsupported' in an error message.
• examples/aoa/single_task_bench/TForest/other_attempts/main.py
  • Corrected typo 'Initializating' to 'Initializing' in logging messages.
• examples/aoa/single_task_bench/TForest/other_attempts/test_update.py
  • Corrected typo 'Initializating' to 'Initializing' in logging messages.
• examples/aoa/single_task_bench/TForest/other_attempts/train_test.py
  • Corrected typo 'Initializating' to 'Initializing' in logging messages.
• examples/aoa/single_task_bench/TForest/task_main.py
  • Corrected typo 'benefical' to 'beneficial' in comments.
  • Corrected typo 'Initializating' to 'Initializing' in logging messages.
• examples/bdd/lifelong_learning_bench/curb-detection/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/bdd/lifelong_learning_bench/curb-detection/testenv/map.py
  • Corrected typo 'overlaped' to 'overlapped' in a comment.
• examples/cifar100/fci_ssl/fed_ci_match/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cifar100/fci_ssl/fed_ci_match_v2/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cifar100/fci_ssl/fedavg/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cifar100/fci_ssl/glfc/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cifar100/federated_class_incremental_learning/fedavg/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cifar100/federated_learning/fedavg/algorithm/basemodel.py
  • Removed f-strings for simple print statements.
• examples/cifar100/federated_learning/fedavg/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cityscapes-synthia/lifelong_learning_bench/curb-detection/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cityscapes-synthia/lifelong_learning_bench/curb-detection/testalgorithms/rfnet/RFNet/eval.py
  • Corrected typo 'accelarate' to 'accelerate' in a comment.
• examples/cityscapes-synthia/lifelong_learning_bench/curb-detection/testalgorithms/rfnet/RFNet/run_server.py
  • Corrected typo 'protocal' to 'protocol'.
• examples/cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/benchmarkingjob-fulltest.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/benchmarkingjob-smalltest.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/benchmarkingjob-traveltest.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/testalgorithms/rfnet/RFNet/eval.py
  • Corrected typo 'accelarate' to 'accelerate' in a comment.
• examples/cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/testalgorithms/rfnet/RFNet/run_server.py
  • Corrected typo 'protocal' to 'protocol'.
• examples/cityscapes-synthia/scene-based-unknown-task-recognition/curb-detection/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cityscapes-synthia/scene-based-unknown-task-recognition/curb-detection/testalgorithms/rfnet/RFNet/eval.py
  • Corrected typo 'accelarate' to 'accelerate' in a comment.
• examples/cityscapes-synthia/scene-based-unknown-task-recognition/curb-detection/testalgorithms/rfnet/RFNet/run_server.py
  • Corrected typo 'protocal' to 'protocol'.
• examples/cityscapes/lifelong_learning_bench/unseen_task_processing-GANwithSelfTaughtLearning/GAN/lpips/init.py
  • Corrected typo 'dimenion' to 'dimension' in a comment.
• examples/cityscapes/lifelong_learning_bench/unseen_task_processing-GANwithSelfTaughtLearning/deeplabv3/model/resnet.py
  • Corrected typo 'entires' to 'entries' in a comment.
• examples/cityscapes/singletask_learning_bench/semantic-segmentation/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/cloud-edge-collaborative-inference-for-llm/README.md
  • Added newlines for better readability around headings and lists.
  • Corrected typo 'pratical' to 'practical'.
  • Corrected typo 'smaples' to 'samples'.
  • Corrected typo 'Defalut' to 'Default' in parameter tables.
• examples/cloud-edge-collaborative-inference-for-llm/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
  • Corrected typo 'absoulute' to 'absolute' in YAML comments.
• examples/cloud-edge-collaborative-inference-for-llm/testalgorithms/query-routing/hard_sample_mining.py
  • Corrected typo 'thresold' to 'threshold'.
• examples/cloud-edge-collaborative-inference-for-llm/testalgorithms/query-routing/models/base_llm.py
  • Corrected typo 'reponse' to 'response' in a docstring.
• examples/cloud-edge-collaborative-inference-for-llm/testalgorithms/query-routing/test_queryrouting.yaml
  • Corrected typo 'reproducable' to 'reproducible' in YAML comments.
  • Corrected typo 'reponse' to 'response' in YAML comments.
• examples/cloud_VLA_finetune/singletask_learning_bench/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/federated-llm/fedllm-peft/README.md
  • Added newlines for better readability around lists and sections.
• examples/government/singletask_learning_bench/objective/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/government/singletask_learning_bench/subjective/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/government_rag/singletask_learning_bench/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/imagenet/multiedge_inference_bench/README.md
  • Corrected typo 'Clasification' to 'Classification' in the title.
  • Corrected typo 'partiton' to 'partition' in a function signature.
  • Added newlines for better readability around headings and code blocks.
• examples/imagenet/multiedge_inference_bench/testalgorithms/automatic/basemodel.py
  • Corrected typo 'modle' to 'model' in an error message.
• examples/imagenet/multiedge_inference_bench/testalgorithms/manual/basemodel.py
  • Corrected typo 'modle' to 'model' in an error message.
• examples/llm-agent/singletask_learning_bench/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/llm_simple_qa/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/pcb-aoi/incremental_learning_bench/fault_detection/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/pcb-aoi/singletask_learning_bench/fault_detection/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/phys_scene_gen/singletask_learning_bench/testalgorithms/ai2holodeck/generation/floor_objects.py
  • Corrected typo 'elemnts' to 'elements' in a comment.
• examples/robot-cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/robot-cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/testalgorithms/erfnet/ERFNet/eval.py
  • Corrected typo 'accelarate' to 'accelerate' in a comment.
• examples/robot-cityscapes-synthia/lifelong_learning_bench/semantic-segmentation/testalgorithms/erfnet/ERFNet/run_server.py
  • Corrected typo 'protocal' to 'protocol'.
• examples/robot/lifelong_learning_bench/semantic-segmentation/benchmarkingjob-sam.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/robot/lifelong_learning_bench/semantic-segmentation/benchmarkingjob-simple.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/robot/lifelong_learning_bench/semantic-segmentation/testalgorithms/rfnet/RFNet/eval.py
  • Corrected typo 'accelarate' to 'accelerate' in a comment.
• examples/robot/lifelong_learning_bench/semantic-segmentation/testalgorithms/rfnet/RFNet/run_server.py
  • Corrected typo 'protocal' to 'protocol'.
• examples/smart_coding/smart_coding_learning_bench/comment/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/smart_coding/smart_coding_learning_bench/issue/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/yaoba/singletask_learning_boost/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/yaoba/singletask_learning_boost/resource/utils/TTA_augs_xyxy_cv2.py
  • Corrected typo 'cooresponding' to 'corresponding' in a docstring.
• examples/yaoba/singletask_learning_boost/resource/utils/transform_unkonwn.py
  • Corrected typo 'cooresponding' to 'corresponding' in a docstring.
• examples/yaoba/singletask_learning_yolox_tta/benchmarkingjob.yaml
  • Corrected typo 'bechmarking' to 'benchmarking' in YAML comments.
• examples/yaoba/singletask_learning_yolox_tta/resource/utils/TTA_augs_xyxy_cv2.py
  • Corrected typo 'cooresponding' to 'corresponding' in a docstring.
• examples/yaoba/singletask_learning_yolox_tta/resource/utils/general_TTA_v4.py
  • Corrected typo 'cooresponding' to 'corresponding' in a docstring.

Activity

• The pull request is categorized as a 'cleanup' type, indicating its focus on improving code quality and maintainability.
• This PR addresses and fixes issue Fix various spelling errors and typos in the documentation and code comments #232, suggesting it resolves a previously identified problem or inconsistency.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request primarily consists of a large number of typo fixes across various file types including Markdown, YAML, and Python files. The changes improve readability and correct spelling errors in comments, docstrings, and log messages. While reviewing, I noticed a few additional opportunities for improvement in core/testcasecontroller/simulation_system_admin/simulation_system_admin.py where function names contained typos that were not addressed. I've added suggestions to correct these for consistency and maintainability.