[GH-ISSUE #641] Suggestions and typos in ai_for_good.qmd #5489

Closed
opened 2026-04-21 21:26:32 -05:00 by GiteaMirror · 3 comments
Owner

Originally created by @BravoBaldo on GitHub (Jan 23, 2025).
Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/641

Originally assigned to: @profvjreddi on GitHub.

In contents/core/ai_for_good/ai_for_good.qmd

  • Search "environmental changes" remove final quotation marks (")
  • Search "while maintaining system efficacy." remove final quotation marks (")
  • Search "Time-critical operations present" the whole paragraph is duplicated.
  • Search "The hierarchical processing pattern organizes" --> "All pattern names are in capital letters: "Hierarchical Processing Pattern"
    • Suggestion: All titles that are pattern names should be completed with "Pattern": "Hierarchical Processing Pattern", "Progressive Enhancement Pattern"....
  • Suggestion: Begin each section of the Patterns with a mnemonic image/chart that describes it.
  • Search "only share model updates", maybe you have to remove "model" (it is a repetition) ?
  • Search "The Adaptive Resource pattern." "P" of "Pattern" must be in uppercase in the image caption.
Originally created by @BravoBaldo on GitHub (Jan 23, 2025). Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/641 Originally assigned to: @profvjreddi on GitHub. In contents/core/ai_for_good/ai_for_good.qmd - Search "environmental changes" remove final quotation marks (") - Search "while maintaining system efficacy." remove final quotation marks (") - Search "Time-critical operations present" the whole paragraph is duplicated. - Search "The hierarchical processing pattern organizes" --> "All pattern names are in capital letters: "Hierarchical Processing Pattern" - Suggestion: All titles that are pattern names should be completed with "Pattern": "Hierarchical Processing Pattern", "Progressive Enhancement Pattern".... - ~~Suggestion: Begin each section of the Patterns with a mnemonic image/chart that describes it.~~ - Search "only share model updates", maybe you have to remove "model" (it is a repetition) ? - Search "The Adaptive Resource pattern." "P" of "Pattern" must be in uppercase in the image caption.
GiteaMirror added the area: booktype: improvement labels 2026-04-21 21:26:32 -05:00
Author
Owner

@profvjreddi commented on GitHub (Jan 23, 2025):

Thank you for reading through it carefully.

  • Search "environmental changes" remove final quotation marks (")
  • Search "while maintaining system efficacy." remove final quotation marks (")

I've seriously got to write some scripts to catch these sorts of mistakes. Thanks for finding these errors.

  • Search "Time-critical operations present" the whole paragraph is duplicated.

Ah editing error, usually I am moving things around and trying to adjust the flow so copy paste left-overs 🤦

  • Search "The hierarchical processing pattern organizes" --> "All pattern names are in capital letters: "Hierarchical Processing Pattern"

I went back and forth on this. I decided to just make them all small cause no where else in the book do I do this.

  • Suggestion: All titles that are pattern names should be completed with "Pattern": "Hierarchical Processing Pattern", "Progressive Enhancement Pattern"....

Thank you for advising me on this. You are correct. I didn't think through much about this during my draft.

  • Suggestion: Begin each section of the Patterns with a mnemonic image/chart that describes it.

That's a great suggestion. I will try. In the past I could easily plop something in but now I am being careful because we are also trying to get the PDF into a good shape at which point I can't easily reuse images for copyright reasons, so we'd have to generate images. So that's why I have been holding back cause images take me a long time to do!

  • Search "only share model updates", maybe you have to remove "model" (it is a repetition) ?

Done!

  • Search "The Adaptive Resource pattern." "P" of "Pattern" must be in uppercase in the image caption.

Done!

<!-- gh-comment-id:2609921278 --> @profvjreddi commented on GitHub (Jan 23, 2025): Thank you for reading through it carefully. > * Search "environmental changes" remove final quotation marks (") > * Search "while maintaining system efficacy." remove final quotation marks (") I've seriously got to write some scripts to catch these sorts of mistakes. Thanks for finding these errors. > * Search "Time-critical operations present" the whole paragraph is duplicated. Ah editing error, usually I am moving things around and trying to adjust the flow so copy paste left-overs 🤦 > * Search "The hierarchical processing pattern organizes" --> "All pattern names are in capital letters: "Hierarchical Processing Pattern" I went back and forth on this. I decided to just make them all small cause no where else in the book do I do this. > * Suggestion: All titles that are pattern names should be completed with "Pattern": "Hierarchical Processing Pattern", "Progressive Enhancement Pattern".... Thank you for advising me on this. You are correct. I didn't think through much about this during my draft. > * ~Suggestion: Begin each section of the Patterns with a mnemonic image/chart that describes it.~ That's a great suggestion. I will try. In the past I could easily plop something in but now I am being careful because we are also trying to get the PDF into a good shape at which point I can't easily reuse images for copyright reasons, so we'd have to generate images. So that's why I have been holding back cause images take me a long time to do! > * Search "only share model updates", maybe you have to remove "model" (it is a repetition) ? Done! > * Search "The Adaptive Resource pattern." "P" of "Pattern" must be in uppercase in the image caption. Done!
Author
Owner

@BravoBaldo commented on GitHub (Jan 23, 2025):

...we are also trying to get the PDF into a good shape...

About the pdf version, the size is very large, about 230MB.
I found out that it is better to produce the DOCX (word) version, maybe edit it to resize some photos, and divide the text in two: Theory and Lab. From the Word format I produce 2 relatively smaller pdfs (34MB and 60MB) that do not create (many) problems for me when saving them in github.

Note: In any case, generating the pdf from Word produces a smaller pdf!

<!-- gh-comment-id:2609982825 --> @BravoBaldo commented on GitHub (Jan 23, 2025): > ...we are also trying to get the PDF into a good shape... About the pdf version, the size is very large, about 230MB. I found out that it is better to produce the DOCX (word) version, maybe edit it to resize some photos, and divide the text in two: Theory and Lab. From the Word format I produce 2 relatively smaller pdfs (34MB and 60MB) that do not create (many) problems for me when saving them in github. Note: In any case, generating the pdf from Word produces a smaller pdf!
Author
Owner

@profvjreddi commented on GitHub (Jan 23, 2025):

Hi @BravoBaldo -- I agree with the PDF size. @hzeljko is helping us with improving the PDF rendering. We will make sure it is small. It is certainly the images.

<!-- gh-comment-id:2610019523 --> @profvjreddi commented on GitHub (Jan 23, 2025): Hi @BravoBaldo -- I agree with the PDF size. @hzeljko is helping us with improving the PDF rendering. We will make sure it is small. It is certainly the images.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/cs249r_book#5489