Improved Documentation: Fixed Typos and Clarity #146
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the documentation by fixing typos, correcting punctuation, and enhancing clarity in two paragraphs. These changes aim to make the documentation more professional and user-friendly.
"a very particular domain" → Changed to "a very specific domain" for clarity.
"with a particular Christmas package" → Removed the comma for better sentence flow.
"with limited data augmentation, resulting" → Kept the comma but ensured overall structure reads naturally.
"the example can be trained on a custom dataset captured by the AI-deck camera, and fitted" → Removed the comma after "camera" as it's not necessary.
"Execution on / flashing the AI-deck" → Changed to "Execution on or flashing the AI-deck" for better formal phrasing.
"The used CNN" → Changed to "The CNN used in this example" for smoother readability.
"MobileNetV2 (alpha = 0.35, image input size=96x96x3)" → Added a space around the equals sign in "image input size = 96x96x3" for consistency and clarity.
"prepended convolutional layers to accept the grayscale/Bayer camera stream of the AI-deck and resize this to MobileNet's expected input shape" → Reworded to "additional convolutional layers to process the grayscale/Bayer camera stream from the AI-deck. These layers resize the input to match MobileNet's expected input shape" to avoid awkward phrasing and improve sentence flow.
"The example was tested on an AI-deck v1.1 with a Bayer color camera equipped" → Changed to "The example was tested on an AI-deck v1.1 equipped with a Bayer color camera" to correct the word order and make it more concise.