Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/dev' into 594-improve-pdf-rend…
Browse files Browse the repository at this point in the history
…ering
  • Loading branch information
hzeljko committed Jan 11, 2025
2 parents 6dd9653 + 641fa3b commit a2a5ad0
Show file tree
Hide file tree
Showing 16 changed files with 180 additions and 95 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_pages_windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Check for build (Windows)

on:
pull_request:
branches:
branches:
- main
- dev

Expand Down
Binary file modified contents/core/introduction/images/png/21st_computer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/core/introduction/images/png/alphafold.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/core/introduction/images/png/book_pillars.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/core/introduction/images/png/ml_lifecycle_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/core/introduction/images/png/triangle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
94 changes: 42 additions & 52 deletions contents/core/introduction/introduction.qmd

Large diffs are not rendered by default.

23 changes: 21 additions & 2 deletions contents/frontmatter/about/about.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ We've designed the book to evolve alongside advancements in the field, fostering

This textbook explores the foundational principles, practical workflows, and critical challenges of building and deploying machine learning systems. Starting with **foundational concepts**, it progresses through **engineering principles**, examines **operational considerations** for deploying AI systems, and concludes by reflecting on the societal and technological implications of machine learning.

```{=latex}
\clearpage
## Learning Goals
### Key Learning Outcomes
Expand All @@ -27,23 +29,35 @@ This book is structured with [Bloom's Taxonomy](https://cft.vanderbilt.edu/guide
![Bloom's Taxonomy (2021 edition).](images/png/bloom_revised_taxonomy.png){#fig-bloom}
1. **Remembering**: Recalling basic facts and concepts.
2. **Understanding**: Explaining ideas or processes.
3. **Applying**: Using knowledge in new situations.
4. **Analyzing**: Breaking down information into components.
5. **Evaluating**: Making judgments based on criteria and standards.
6. **Creating**: Producing original work or solutions.
### Learning Objectives
This book supports readers in:
1. **Understanding Fundamentals**: Explain the foundational principles of machine learning, including theoretical underpinnings and practical applications.
2. **Analyzing System Components**: Evaluate the critical components of AI systems and their roles within various architectures.
3. **Designing Workflows**: Outline workflows for developing machine learning systems, from data collection to deployment.
4. **Optimizing Models**: Apply methods to enhance performance, such as hyperparameter tuning and regularization.
4. **Optimizing Models**: Apply methods to enhance performance, such as hyperparameter tuning and regularization.
5. **Evaluating Ethical Implications**: Analyze societal impacts and address potential biases in AI systems.
6. **Exploring Applications**: Investigate real-world use cases across diverse domains.
6. **Exploring Applications**: Investigate real-world use cases across diverse domains.
7. **Considering Deployment Challenges**: Address security, scalability, and maintainability in real-world systems.
8. **Envisioning Future Trends**: Reflect on emerging challenges and technologies in machine learning.
### AI Learning Companion
Expand Down Expand Up @@ -73,16 +87,21 @@ The book is organized into four main parts, each building on the previous one:
### Suggested Reading Paths
- **Beginners**: Start with *The Essentials* to build a strong conceptual base before progressing to other parts.
- **Practitioners**: Focus on *Engineering Principles* and *AI in Practice* for hands-on, real-world insights.
- **Researchers**: Dive into *AI in Practice* and *Closing Perspectives* to explore advanced topics and societal implications.
### Modular Design
The book is modular, allowing readers to explore chapters independently or sequentially. Each chapter includes supplementary resources:
- **Slides** summarizing key concepts.
- **Videos** providing in-depth explanations.
- **Exercises** reinforcing understanding.
- **Labs** offering practical, hands-on experience.
While several of these resources are still a work in progress, we believe it's better to share valuable insights and tools as they become available rather than wait for everything to be perfect. After all, progress is far more important than perfection, and your feedback will help us improve and refine this resource over time.
Expand Down
Binary file modified contents/frontmatter/ai/images/png/badges.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/frontmatter/ai/images/png/chat_ask.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/frontmatter/ai/images/png/chat_explanation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/frontmatter/ai/images/png/chat_related.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/frontmatter/ai/images/png/download_report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified contents/frontmatter/ai/images/png/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
84 changes: 74 additions & 10 deletions contents/frontmatter/ai/socratiq.qmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# 🤖 SocratiQ AI {.unnumbered}
# SocratiQ AI {.unnumbered}

## AI Learning Companion

Welcome to SocratiQ (pronounced "Socratic"), an AI learning assistant seamlessly integrated throughout this resource. Inspired by the Socratic method of teaching—emphasizing thoughtful questions and answers to stimulate critical thinking—SocratiQ is part of our experiment with what we call as _Generative Learning._ By combining interactive quizzes, personalized assistance, and real-time feedback, SocratiQ is meant to reinforce your understanding and help you create new connections. _SocratiQ is still a work in progress, and we welcome your feedback._
Welcome to SocratiQ (pronounced ``Socratic''), an AI learning assistant seamlessly integrated throughout this resource. Inspired by the Socratic method of teaching—emphasizing thoughtful questions and answers to stimulate critical thinking—SocratiQ is part of our experiment with what we call as _Generative Learning._ By combining interactive quizzes, personalized assistance, and real-time feedback, SocratiQ is meant to reinforce your understanding and help you create new connections. _SocratiQ is still a work in progress, and we welcome your feedback._

::: {.content-visible unless-format="html"}
Listen to this AI-generated podcast about SocratiQ [here](https://mlsysbook.ai/contents/ai/socratiq.html).
Expand Down Expand Up @@ -105,7 +105,13 @@ Once you've enabled SocratiQ it will always be available when you visit this sit

You can access SocratiQ at any time using a keyboard shortcut shown in @fig-main-shortcut, which brings up the interface shown in @fig-main-interface.

::: {.content-visible when-format="html"}
![Keyboard shortcut for SocratiQ.](images/png/shortcut.png){#fig-main-shortcut}
:::

::: {.content-visible when-format="pdf"}
![Keyboard shortcut for SocratiQ.](images/png/shortcut.png){#fig-main-shortcut width=40%}
:::

![The main SocratiQ interface, showing the key components of your AI learning assistant.](images/png/interface.png){#fig-main-interface}

Expand All @@ -117,22 +123,26 @@ The top nav bar provices quick access to the following features:
2. Track your [progress](#sec-socratiq-dashboard) by viewing the dashboard.
3. Start new or save your [conversations](#sec-socratiq-learning) with SocratiQ.

::: {.content-visible when-format="pdf"}
![View of the top nav menu. ](images/png/top_menu.png){#fig-top-menu width=60%}
:::

::: {.content-visible when-format="html"}
![View of the top nav menu. ](images/png/top_menu.png){#fig-top-menu}
:::

## Personalize Your Learning {#sec-socratiq-settings}

Before diving into your studies, take a moment to configure SocratiQ for your academic level. This initial setup ensures that all interactions, from quiz questions to explanations, are tailored to your background knowledge. @fig-settings-panel shows where you can adjust these preferences.

![The settings panel where you can customize SocratiQ to match your academic level.](images/png/settings.png){#fig-settings-panel}

You can augment any AI SocratiQ response using the dropdown menu at the top of each message.

::: {.content-visible when-format="html"}
![Redo an AI message by choosing a new experience level.](images/gif/adjust_message_difficulty.gif){#fig-adjust_message_difficulty}
::: {.content-visible when-format="pdf"}
![The settings panel where you can customize SocratiQ to match your academic level.](images/png/settings.png){#fig-settings-panel width=45%}
:::

::: {.content-visible when-format="pdf"}
![Redo an AI message by choosing a new experience level..](images/png/adjust_message_difficulty.png){#fig-adjust_message_difficulty}
::: {.content-visible when-format="html"}
![The settings panel where you can customize SocratiQ to match your academic level.](images/png/settings.png){#fig-settings-panel}
:::

## Learning with SocratiQ {#sec-socratiq-learning}
Expand All @@ -141,20 +151,44 @@ You can augment any AI SocratiQ response using the dropdown menu at the top of e

As you progress through each section of the textbook, you have the option to ask SocratiQ to automatically generate quizzes tailored to reinforce key concepts. These quizzes are conveniently inserted at the end of every major subsection (e.g., 1.1, 1.2, 1.3, and so on), as illustrated in @fig-quiz-interface.

::: {.content-visible when-format="html"}
![Redo an AI message by choosing a new experience level.](images/gif/adjust_message_difficulty.gif){#fig-adjust_message_difficulty}
:::

::: {.content-visible when-format="pdf"}
![Redo an AI message by choosing a new experience level..](images/png/adjust_message_difficulty.png){#fig-adjust_message_difficulty width=90%}
:::


![Quizzes are generated at the end of every section.](images/png/quiz_button2.png){#fig-quiz-interface}

Each quiz typically consists of 3-5 multiple-choice questions and takes only 1-2 minutes to complete. These questions are designed to assess your understanding of the material covered in the preceding section, as shown in @fig-quiz-questions.

Upon submitting your answers, SocratiQ provides immediate feedback along with detailed explanations for each question, as demonstrated in @fig-quiz-answers.

::: {#fig-quizzes layout-ncol=2}

::: {.content-visible when-format="html"}
::: {#fig-quizzes layout="[[43,-14,43]]"}
![Example of AI-generated quiz questions.](images/png/quiz_questions.png){#fig-quiz-questions}

![Example of AI-generated feedback and explanations for quizzes.](images/png/quiz_answers.png){#fig-quiz-answers}

SocratiQ uses a Large Language Model (LLM) to automatically generate and grade quizzes.
:::
:::

::: {.content-visible when-format="pdf"}
::: {.column-margin}
\addtocounter{figure}{1}
Figure \thefigure: SocratiQ uses a Large Language Model (LLM) to automatically generate and grade quizzes.
\addtocounter{figure}{-1}
:::

::: {#fig-quizzes layout="[[43,-14,43]]"}
![Example of AI-generated quiz questions.](images/png/quiz_questions.png){#fig-quiz-questions width=90%}

![Example of AI-generated feedback and explanations for quizzes.](images/png/quiz_answers.png){#fig-quiz-answers width=90%}
:::
:::

### Example Learning Flow

Expand All @@ -172,7 +206,13 @@ When you encounter challenging concepts, SocratiQ offers two powerful ways to ge

Once you've selected the text, you can ask questions about it, and SocratiQ will provide detailed explanations based on that context, as illustrated in @fig-context-explanation.

::: {.content-visible when-format="html"}
![Example of how SocratiQ provides explanations based on selected text.](images/png/chat_ask.png){#fig-context-explanation}
:::

::: {.content-visible when-format="pdf"}
![Example of how SocratiQ provides explanations based on selected text.](images/png/chat_ask.png){#fig-context-explanation width=60%}
:::

@fig-interactive-chat shows the response for the ask in @fig-context-explanation.

Expand All @@ -187,11 +227,23 @@ You can also click the `+ Context` button right above the input.
![Referencing different sections from the textbook.](images/png/reference.png){#fig-reference-sections}
:::

::: {.content-visible when-format="html"}
![An interactive chat session with SocratiQ, demonstrating how to get clarification on concepts.](images/png/chat_explanation.png){#fig-interactive-chat}
:::

::: {.content-visible when-format="pdf"}
![An interactive chat session with SocratiQ, demonstrating how to get clarification on concepts.](images/png/chat_explanation.png){#fig-interactive-chat width=40%}
:::

To enhance your learning experience, SocratiQ doesn't just answer your questions---it also suggests related content from the textbook that might be helpful for deeper understanding, as shown in @fig-related-content.

::: {.content-visible when-format="html"}
![SocratiQ suggests related content based on your questions to help deepen your understanding.](images/png/chat_related.png){#fig-related-content}
:::

::: {.content-visible when-format="pdf"}
![SocratiQ suggests related content based on your questions to help deepen your understanding.](images/png/chat_related.png){#fig-related-content width=50%}
:::

## Tracking Your Progress {#sec-socratiq-dashboard}

Expand Down Expand Up @@ -220,11 +272,23 @@ As you progress through the quizzes, you'll earn special badges to mark your ach
Keep taking quizzes to collect all badges and improve your learning journey! Your current badges will appear in the quiz statistics dashboard.
:::

::: {.content-visible when-format="html"}
![Examples of achievement badges you can earn through consistent engagement.](images/png/badges.png){#fig-achievement-badges}
:::

::: {.content-visible when-format="pdf"}
![Examples of achievement badges you can earn through consistent engagement.](images/png/badges.png){#fig-achievement-badges width=40%}
:::

If you'd like a record of your progress you can generate a PDF report. It will show your progress, average performance and all the questions you've attempted. The PDF is a generated with a unique hash and can be uniquely validated.

::: {.content-visible when-format="html"}
![You can click the Download Report button to view your report. You can verify that your PDF has been created by SocratiQ by clicking the verify button and uploading your generated PDF. ](images/png/download_report.png){#fig-download-report}
:::

::: {.content-visible when-format="pdf"}
![You can click the Download Report button to view your report. You can verify that your PDF has been created by SocratiQ by clicking the verify button and uploading your generated PDF. ](images/png/download_report.png){#fig-download-report width=90%, fig-pos='htb'}
:::

## Data Storage

Expand Down
Loading

0 comments on commit a2a5ad0

Please sign in to comment.