Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved Documentation: Fixed Typos and Clarity #146

Merged
merged 2 commits into from
Nov 19, 2024

Conversation

jjestrada2
Copy link
Contributor

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.

Copy link
Member

@gemenerik gemenerik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR Juanito, much appreciated!

@gemenerik gemenerik merged commit 2e28391 into bitcraze:master Nov 19, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants