` with an `id` of `title`. Then put the name of your gallery inside it !
+- Inside your `` , create an `` tag inside a `
` tag inside a `` with the `id` **title**. Then put the name of your gallery inside the `` section !
```HTML
@@ -77,7 +77,7 @@ Inside your HTML file, set up the basic structure of the HTML document with a `<
#### 3- Put your robots inside the gallery:
-- Under the `title` div, create a div element with the `id` `gallery`.
+- Under the `title` div, create a div element with the `id` **gallery**.
- This div will serve as the container for all the robot portraits.
@@ -209,7 +209,7 @@ h3 {
> Trust the process!
-- Then add this gallery style block, and change the `background-color` of it based on your team's favorite color:
+- Then add this gallery style block, and change its `background-color` based on your team's favorite color:
```css
#gallery {
@@ -223,17 +223,17 @@ h3 {
}
```
-- Add the following block of style to all your class's of `name-robot`. To do so, we follow the rule:
+- Add the following style block to all your `name-robot` classes. To do so, we follow the rule:
```css
.class-one,
.class-two,
.class-three {
- /* block of style */
+ /* style block */
}
```
-- Name it with your `name-robot` for each member of the team, and put inside the block the following styles:
+- Name it with the `name-robot` of each teammember, and add inside the block the following styles:
```css
{
@@ -266,9 +266,9 @@ h3 {
> Experiment by changing the colors of the box-shadow and the scale value! Be creative.
-- In your `#gallery` CSS rule, add some animated gradient color to the background! You can achieve it by combining CSS properties: `background`, `background-size`, `animation`, `box-shadow`.
+- In your `#gallery` CSS rule, add some animated gradient color to the background! You can achieve it by combining CSS properties: `background`, `background-size`, `animation` and `box-shadow`.
-> Hint : Do not forget to replace the background property with the new value bellow!
+> Hint : Do not forget to replace the background property with the new value below!
_For Example:_
@@ -284,9 +284,9 @@ animation: gradientBackground 2s ease infinite; /* Animates the background to cr
box-shadow: 0 5px 15px rgba(0, 0, 0, 0.2); /* Adds a shadow around the element. Adjust the offsets, blur radius, and opacity as needed */
```
-> You saw no change? well we did not specify yet what to do with all those colors, angles and timing yet!
+> You didn't see any change? Well we didn't specify what to do with all those colors, angles and timing yet!
-- Let's make it more exciting, by actually making the colors move! We can do that with `keyframes`! Under the `#gallery` css rule, put the `keyframes`` block and see the magic !
+- Let's make it more exciting by actually making the colors move! We can do that with `keyframes`! Under the `#gallery` css rule, put the `keyframes` block and see the magic !
_For Example:_
@@ -310,7 +310,7 @@ _For Example:_
- "How do I create a smooth gradient background with multiple colors in CSS?"
-- "Explain to me as a beginner these CSS properties: `background`, `background-size`, `animation`, `box-shadow`."
+- "Explain to me as a beginner these CSS properties: `background`, `background-size`, `animation` and `box-shadow`."
### Task 3: Add Interactivity with JavaScript:
@@ -324,15 +324,15 @@ Follow the following steps:
- Create a function named `changeArmColor`.
- This function should accept a parameter `robotClass` to identify which robot to modify.
- - Inside the function, generate a random color using JavaScript, to both `left` and `right` arms.
+ - Inside the function, generate a random color using JavaScript, to apply to both `left` and `right` arms.
```js
const randomColor = `#${Math.floor(Math.random() * 16777215).toString(16)}`;
```
- Use `document.querySelector` to select the `left` and `right` arm elements of the robot.
- - Apply the random color to both arm elements using `style.backgroundColor`.
- - Here is an example, do the same for right arm:
+ - Apply the random color to both arm' elements using `style.backgroundColor`.
+ - Below is an example, do the same for the right arm:
```js
const randomColor = `#${Math.floor(Math.random() * 16777215).toString(16)}`;
@@ -340,30 +340,30 @@ Follow the following steps:
document.querySelector(`.${robotClass} #arm-left`).style.backgroundColor =
randomColor;
- //do the same to right arm
+ //do the same to the right arm
```
- **Function to Change Legs Colors**:
- Create a function named `changeLegColor`.
- - Follow the same steps as the `changeArmColor` function but target the `legs`.
+ - Follow the same steps as the `changeArmColor` function but have it target the `legs`.
- **Function to Change Eye Colors**:
- Create a function named `changeEyeColor`.
- - Follow the same steps as the `changeArmColor` function but target the `eye`.
+ - Follow the same steps as the `changeArmColor` function but have it target the `eye`.
- **Function to Change Face Colors**:
- Create a function named `changeFaceColor`.
- - Follow the same steps as the `changeArmColor` function but target the `eyes` `id`. (Yes, pay attention, the `id` that changes the face color is called `eyes`!)
+ - Follow the same steps as the `changeArmColor` function but target the `eyes` **id**. (Yes, pay attention, the `id` that changes the face color is called `eyes`!)
#### 3- Adding Event Listeners for Keyboard Input:
Next, you need to detect when specific keys are pressed and trigger the corresponding function.
- Use `document.addEventListener` to listen for `keydown` events.
-- Inside the event listener, use multiple `if` statements to check which `key` was `pressed`.
+- Inside the event listener, use multiple `if` statements to check which `key` is `pressed`.
- Depending on the `key` pressed, call the appropriate `function` and pass the `robot's class` as an `argument`.
_Code example:_
@@ -389,7 +389,7 @@ document.addEventListener("keydown", function (event) {
});
```
-- You should decide with your team mates the keys that will trigger each robot of yours!
+- You should decide with your teammates the keys that will trigger each of your robots!
**`Prompt Example:`**
@@ -400,13 +400,13 @@ document.addEventListener("keydown", function (event) {
- Ensure that all robots are displayed correctly in the gallery.
-- Make sure all files (robots-harmony.html, robots-harmony.css, robots-harmony.js) are in the same folder submitted to your `Gitea`.
+- Make sure all files (robots-harmony.html, robots-harmony.css, robots-harmony.js) are in the same folder submitted in the repository of your `Gitea` account.
- Double-check the code to ensure everything is clean and well-organized.
### Expected Output
-Your project needs to check all the previous tasks, it will look something close to (and maybe better than) [this](https://youtu.be/pWD0tbyTyiI).
+Your project needs to check all the previous tasks, it will look something close to (and maybe better than) [this](https://youtu.be/drQsUzPeoAQ).
### Bonus part
diff --git a/subjects/DPxAI/robots-harmony/audit/README.md b/subjects/AI.GO/robots-harmony/audit/README.md
similarity index 100%
rename from subjects/DPxAI/robots-harmony/audit/README.md
rename to subjects/AI.GO/robots-harmony/audit/README.md
diff --git a/subjects/DPxAI/select-then-style/README.md b/subjects/AI.GO/select-then-style/README.md
similarity index 95%
rename from subjects/DPxAI/select-then-style/README.md
rename to subjects/AI.GO/select-then-style/README.md
index 346d7313e..d7c8db2dd 100644
--- a/subjects/DPxAI/select-then-style/README.md
+++ b/subjects/AI.GO/select-then-style/README.md
@@ -32,7 +32,7 @@ Now that you have created and properly identified the different sections of your
- `width` of `100%`
- `height` of `calc(100% / 3)` _(one third of the `body` height)_
-- Target each of the following elements with the [`id` selector][4], using the `id` you defined earlier for each section, and style them:
+- Target each of the following elements with the [id selector][4], using the `id` you defined earlier for each section, and style them:
- `face` with a "cyan" `background-color`
- `upper-body` with a "blueviolet" `background-color`
- `lower-body` with a "lightsalmon" `background-color`
diff --git a/subjects/DPxAI/star-forge/README.md b/subjects/AI.GO/star-forge/README.md
similarity index 100%
rename from subjects/DPxAI/star-forge/README.md
rename to subjects/AI.GO/star-forge/README.md
diff --git a/subjects/DPxAI/the-skeleton/README.md b/subjects/AI.GO/the-skeleton/README.md
similarity index 93%
rename from subjects/DPxAI/the-skeleton/README.md
rename to subjects/AI.GO/the-skeleton/README.md
index 3ec477379..47dcfa1c1 100644
--- a/subjects/DPxAI/the-skeleton/README.md
+++ b/subjects/AI.GO/the-skeleton/README.md
@@ -24,7 +24,7 @@ We provide you with some content to get started smoothly, check it out!
- Video [Basic set up of an HTML page](https://www.youtube.com/watch?v=QtKoO7tT-Gg&list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF&index=1)
- Video [Different HTML tags overview](https://www.youtube.com/watch?v=Al-Jzpib8VY&list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF&index=2)
-Those videos are accompanying you step by step in each exercise, but if you want to check right away all the notions covered in the quest, you can watch the whole playlist throughout your next exercices[Web - HTML, CSS & DOM JavaScript](https://www.youtube.com/playlist?list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF).
+Those videos are accompanying you step by step in each exercise, but if you want to check right away all the notions covered in the quest, you can watch the whole playlist throughout your next exercises[Web - HTML, CSS & DOM JavaScript](https://www.youtube.com/playlist?list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF).
> Your working environment may not be exactly the same as what you see in the videos or documentation, just try to adapt your work according to your research and discoveries.
> Don't be afraid to try!
@@ -52,7 +52,7 @@ Choose a power that you will give to your robot from the following list and put
#### The `` part:
-This section contains the content of your webpage , in our case the lower body of your buddy. Define the skeleton of your robot by organizing it into three main sections: the face, the upper body, and the lower body. Inside the tag of your HTML file, create three divisions using tags, and place the following text content inside each one: face, upper-body, lower-body.
+This section contains the content of your webpage , in our case the lower body of your buddy. Define the skeleton of your robot by organizing it into three main sections: the face, the upper body, and the lower body. Inside the `` tag of your HTML file, create three divisions using `` tags, and place the following text content inside each one: face, upper-body, lower-body.
> Don't forget to press Render again to refresh the display page when you modify your code.
diff --git a/subjects/DPxAI/the-smooth-operator/README.md b/subjects/AI.GO/the-smooth-operator/README.md
similarity index 100%
rename from subjects/DPxAI/the-smooth-operator/README.md
rename to subjects/AI.GO/the-smooth-operator/README.md
diff --git a/subjects/DPxAI/transform-objects/README.md b/subjects/AI.GO/transform-objects/README.md
similarity index 91%
rename from subjects/DPxAI/transform-objects/README.md
rename to subjects/AI.GO/transform-objects/README.md
index e3f8619f1..c9da92e96 100644
--- a/subjects/DPxAI/transform-objects/README.md
+++ b/subjects/AI.GO/transform-objects/README.md
@@ -65,14 +65,14 @@ robot.code = undefined;
Modify the provided `robot` variable:
- Add a `model` property with the string value 'RX-78'.
-- Add a `fullName` property that is the joined value of the `brand` and the `model` with a space in between.
+- Add a `fullName` property that is the joined value of the `brand` and the `model` with a space in between. (`brand` and `model`are already defined in the provided `robot`)
- Add `10` to its `batteryLevel` property.
#### Task 2:
Let's move away from objects a bit, and discover a notion we will use later. `Duplicating a String with Placeholders`!
-Declare a variable `duplicate` that repeats the provided variable `sentence`, separated by a comma, and adds an exclamation mark at the end.
+Declare a variable `duplicate` that repeats the provided variable `sentence`, separated by a comma and a space, and then adds an exclamation mark at the end.
> For example, if `sentence` is "Hello there", we expect "Hello there, Hello there!".
diff --git a/subjects/ai/backtesting-sp500/README.md b/subjects/ai/backtesting-sp500/README.md
index 54fca3fb9..b9c59167d 100644
--- a/subjects/ai/backtesting-sp500/README.md
+++ b/subjects/ai/backtesting-sp500/README.md
@@ -1,10 +1,31 @@
-# Backtesting on the SP500
+## Backtesting-SP500
-## SP500 data preprocessing
+### Overview
The goal of this project is to perform a Backtest on the SP500 constituents, which represents the 500 largest companies by market capitalization in the United States.
-## Data
+### Role Play
+
+You are a quantitative analyst at a prestigious hedge fund. Your manager has tasked you with developing and backtesting a stock-picking strategy using historical data from the S&P 500 index. The goal is to create a strategy that outperforms the market benchmark. You'll need to clean and preprocess messy financial data, develop a signal for stock selection, implement a backtesting framework, and present your findings to the investment committee.
+
+### Learning Objectives
+
+By the end of this project, you will be able to:
+
+1. Optimize data types in large datasets to improve memory efficiency
+2. Perform exploratory data analysis on financial time series data
+3. Identify and handle outliers and missing values in stock price data
+4. Preprocess financial data, including resampling and calculating returns
+5. Develop a simple stock selection signal based on historical performance
+6. Implement a backtesting framework for evaluating trading strategies
+7. Compare the performance of a custom strategy against a market benchmark
+8. Visualize financial performance data using appropriate charts and graphs
+9. Write modular, reusable code for financial data analysis and strategy testing
+10. Interpret and communicate the results of a quantitative trading strategy
+
+### Instructions
+
+#### Data
The input files are:
@@ -24,42 +45,15 @@ _Note: The quality of this data set is not good: some prices are wrong, there ar
_Note: The corrections will not fix the data, as a result the results may be abnormal compared to results from cleaned financial data. That's not a problem for this small project !_
-## Problem
+#### Problem
Once preprocessed this data, it will be used to generate a signal that is, for each asset at each date a metric that indicates if the asset price will increase the next month. At each date (once a month) we will take the 20 highest metrics and invest $1 per company. This strategy is called **stock picking**. It consists in picking stock in an index and try to over perform the index. Finally, we will compare the performance of our strategy compared to the benchmark: the SP500
It is important to understand that the SP500 components change over time. The reason is simple: Facebook entered the SP500 in 2013 thus meaning that another company had to be removed from the 500 companies.
-The structure of the project is:
-
-```console
-project
-│ README.md
-│ environment.yml
-│
-└───data
-│ │ sp500.csv
-│ | prices.csv
-│
-└───notebook
-│ │ analysis.ipynb
-|
-|───scripts
-| │ memory_reducer.py
-| │ preprocessing.py
-| │ create_signal.py
-| | backtester.py
-│ | main.py
-│
-└───results
- │ plots
- │ results.txt
- │ outliers.txt
-```
-
There are four parts:
-## 1. Preliminary
+#### 1. Preliminary
- Create a function that takes as input one CSV data file. This function should optimize the types to reduce its size and returns a memory optimized DataFrame.
- For `float` data the smaller data type used is `np.float32`
@@ -71,7 +65,7 @@ There are four parts:
4. Find the min and the max value
5. Determine and apply the smallest datatype that can fit the range of values
-## 2. Data wrangling and preprocessing
+#### 2. Data wrangling and preprocessing
- Create a Jupyter Notebook to analyze the data sets and perform EDA (Exploratory Data Analysis). This notebook should contain at least:
@@ -112,7 +106,7 @@ At this stage the DataFrame should look like this:
- Resample data on month and keep the last value
- Compute historical monthly returns on the adjusted close
-## 3. Create signal
+#### 3. Create signal
At this stage we have a data set with features that we will leverage to get an investment signal. As previously said, we will focus on one single variable to create the signal: **monthly_past_return**. The signal will be the average of monthly returns of the previous year
@@ -121,7 +115,7 @@ The naive assumption made here is that if a stock has performed well the last ye
- Create a column `average_return_1y`
- Create a column named `signal` that contains `True` if `average_return_1y` is among the 20 highest in the month `average_return_1y`.
-## 4. Backtester
+#### 4. Backtester
At this stage we have an investment signal that indicates each month what are the 20 companies we should invest 1$ on (1$ each). In order to check the strategies and performance we will backtest our investment signal.
@@ -135,9 +129,9 @@ A data point (x-axis: date, y-axis: cumulated_return) is: the **cumulated return
![alt text][performance]
-[performance]: images/w1_weekend_plot_pnl.png 'Cumulative Performance'
+[performance]: images/w1_weekend_plot_pnl.png "Cumulative Performance"
-## 5. Main
+#### 5. Main
Here is a sketch of `main.py`.
@@ -158,3 +152,83 @@ backtest(prices, sp500)
```
**The command `python main.py` executes the code from data imports to the backtest and save the results.**
+
+### Project repository structure:
+
+```console
+project
+│ README.md
+│ requirements.txt
+│
+└───data
+│ │ sp500.csv
+│ | prices.csv
+│
+└───notebook
+│ │ analysis.ipynb
+|
+|───scripts
+| │ memory_reducer.py
+| │ preprocessing.py
+| │ create_signal.py
+| | backtester.py
+│ | main.py
+│
+└───results
+ │ plots
+ │ results.txt
+ │ outliers.txt
+```
+
+### Tips:
+
+1. Data Quality Management:
+
+ - Be prepared to encounter messy data. Financial datasets often contain errors, outliers, and missing values.
+ - Develop a systematic approach to identify and handle data quality issues.
+
+2. Memory Optimization:
+
+ - When working with large datasets, optimize memory usage by selecting appropriate data types for each column.
+ - Consider using smaller data types like np.float32 for floating-point numbers when precision allows.
+
+3. Exploratory Data Analysis:
+
+ - Spend time understanding the data through visualization and statistical analysis before diving into strategy development.
+ - Pay special attention to outliers and their potential impact on your strategy.
+
+4. Preprocessing Financial Data:
+
+ - When resampling time series data, be mindful of which value to keep (e.g., last value for month-end prices).
+ - Calculate both historical and future returns to avoid look-ahead bias in your strategy.
+
+5. Handling Outliers:
+
+ - Develop a method to identify and handle outliers that is specific to each company's historical data.
+ - Be cautious about removing outliers during periods of high market volatility (e.g., 2008-2009 financial crisis).
+
+6. Signal Creation:
+
+ - Start with a simple signal (like past 12-month average returns) before exploring more complex strategies.
+ - Ensure your signal doesn't use future information that wouldn't have been available at the time of decision.
+
+7. Backtesting:
+
+ - Implement your backtesting logic without using loops for better performance.
+ - Compare your strategy's performance against a relevant benchmark (in this case, the S&P 500).
+
+8. Visualization:
+
+ - Create clear, informative visualizations to communicate your strategy's performance.
+ - Include cumulative return plots to show how your strategy performs over time compared to the benchmark.
+
+9. Code Structure:
+
+ - Organize your code into modular functions for better readability and reusability.
+ - Use a main script to orchestrate the entire process from data loading to results visualization.
+
+10. Results Interpretation:
+ - Don't just focus on total returns. Consider other metrics like risk-adjusted returns, maximum drawdown, etc.
+ - Be prepared to explain any anomalies or unexpected results in your strategy's performance.
+
+Remember, the goal is not just to create a strategy that looks good on paper, but to develop a robust process for analyzing financial data and testing investment ideas.
diff --git a/subjects/ai/backtesting-sp500/audit/README.md b/subjects/ai/backtesting-sp500/audit/README.md
index fdf200d93..27ba69dac 100644
--- a/subjects/ai/backtesting-sp500/audit/README.md
+++ b/subjects/ai/backtesting-sp500/audit/README.md
@@ -1,11 +1,11 @@
-#### Functional
+#### Backtesting-SP500
###### Is the structure of the project as below?
```
project
│ README.md
-│ environment.yml
+│ requirements.txt
│
└───data
│ │ sp500.csv
@@ -30,7 +30,7 @@ project
###### Does the readme file contain a description of the project, explain how to run the code from an empty environment, give a summary of the implementation of each python file and contain a conclusion that gives the performance of the strategy?
-###### Does the environment contain all libraries used and their versions that are necessary to run the code?
+###### Does the requirements contain all libraries used and their versions that are necessary to run the code?
###### Does the notebook contain a missing values analysis? **Example**: number of missing values per variables or per year
@@ -107,7 +107,7 @@ Best practice:
![alt text][performance]
-[performance]: ../images/w1_weekend_plot_pnl.png 'Cumulative Performance'
+[performance]: ../images/w1_weekend_plot_pnl.png "Cumulative Performance"
##### 5. main.py
diff --git a/subjects/ai/credit-scoring/README.md b/subjects/ai/credit-scoring/README.md
index d74008b31..3ed8741a7 100644
--- a/subjects/ai/credit-scoring/README.md
+++ b/subjects/ai/credit-scoring/README.md
@@ -1,16 +1,24 @@
## Credit scoring
+### Overview
+
The goal of this project is to implement a scoring model based on various source of data ([check data documentation](./readme_data.md)) that returns the probability of default. In a nutshell, credit scoring represents an evaluation of how well the bank's customer can pay and is willing to pay off debt. It is also required that you provide an explanation of the score. For example, your model returns that the probability that one client doesn't pay back the loan is very high (90%). The reason behind is that variable_xxx which represents the ability to pay back the past loan is low. The output interpretability will appear in a visualization.
-The ability to understand the underlying factors of credit scoring is important. Credit scoring is subject to more and more regulation, so transparency is key. And more generally, more and more companies prefer transparency to black box models.
+### Role play
-### Resources
+Hey there, future credit scoring expert! Ready to dive into the exciting world of predicting loan defaults? You're in for a treat! This project is all about building a nifty model that can help figure out how likely someone is to pay back their loan. Cool, right?
+
+### Learning Objective
+
+The ability to understand the underlying factors of credit scoring is important. Credit scoring is subject to more and more regulation, so transparency is key. And more generally, more and more companies prefer transparency to black box models.
Historical timeline of machine learning techniques applied to credit scoring
- [Machine Learning or Econometrics for Credit Scoring: Let’s Get the Best of Both Worlds](https://hal.archives-ouvertes.fr/hal-02507499v3/document)
-### Scoring model
+### Instructions
+
+#### Scoring model
There are 3 expected deliverables associated with the scoring model:
@@ -18,21 +26,28 @@ There are 3 expected deliverables associated with the scoring model:
- The trained machine learning model with the features engineering pipeline:
- Do not forget: **Coming up with features is difficult, time-consuming, requires expert knowledge. ‘Applied machine learning’ is basically feature engineering.**
- - The model is validated if the **AUC on the test set is higher than 75%**.
+ - The model is validated if the **AUC on the test set is at minimum 55%, ideally to 62% included (or in best cases higher than 62% if you can !)**.
- The labelled test data is not publicly available. However, a Kaggle competition uses the same data. The procedure to evaluate test set submission is the same as the one used for the project 1.
+ - Here are the [DataSets](https://assets.01-edu.org/ai-branch/project5/home-credit-default-risk.zip).
+
+- A report on model training and evaluation:
+
+ - Include learning curves (training and validation scores vs. training set size or epochs) to demonstrate that the model is not overfitting.
+ - Explain the measures taken to prevent overfitting, such as early stopping or regularization techniques.
+ - Justify your choice of when to stop training based on the learning curves.
-### Kaggle submission
+#### Kaggle submission
The way the Kaggle platform works is explained in the challenge overview page. If you need more details, I suggest [this resource](https://towardsdatascience.com/getting-started-with-kaggle-f9138b35ae18) that gives detailed explanations.
- Create a username following that structure: username*01EDU* location_MM_YYYY. Submit the description profile and push it on the Git platform the first day of the week. Do not touch this file anymore.
-- A text document that describes the methodology used to train the machine learning model:
+- A text document `model_report.txt` that describes the methodology used to train the machine learning model :
- Algorithm
- Why the accuracy shouldn't be used in that case?
- Limit and possible improvements
-### Model interpretability
+#### Model interpretability
This part hasn't been covered during the piscine. Take the time to understand this key concept.
There are different level of transparency:
@@ -55,16 +70,16 @@ Choose the 3 clients of your choice, compute the score, run the visualizations o
- 1 on which the model is correct and the other on which the model is wrong. Try to understand why the model got wrong on this client.
- Take 1 client from the test set
-### Optional
+#### Bonus
Implement a dashboard (using [Dash](https://dash.plotly.com/)) that takes as input the customer id and that returns the score and the required visualizations.
-### Deliverables
+### Project repository structure:
```
project
│ README.md
-│ environment.yml
+│ requirements.txt
│
└───data
│ │ ...
@@ -93,17 +108,17 @@ project
│ │ preprocess.py
```
-- `README.md` introduces the project and shows the username.
-- `environment.yml` contains all libraries required to run the code.
+- `README.md` introduces the project, how to run the code, and shows the username.
+- `requirements.txt` contains all libraries required to run the code.
- `username.txt` contains the username, the last modified date of the file **has to correspond to the first day of the project**.
- `EDA.ipynb` contains the exploratory data analysis. This file should contain all steps of data analysis that contributed or not to improve the score of the model. It has to be commented so that the reviewer can understand the analysis and run it without any problem.
- `scripts` contains python file(s) that perform(s) the feature engineering, the model's training and prediction on the test set. It could also be one single Jupyter Notebook. It has to be commented to help the reviewers understand the approach and run the code without any bugs.
-### Useful resources
+### Tips
-- [Interpreting machine learning models](https://towardsdatascience.com/interpretability-in-machine-learning-70c30694a05f)
+Remember, creating a great credit scoring model is like baking a perfect cake - it takes the right ingredients, careful preparation, and a dash of creativity. You've got this!
-### Files needed for this project
+### Resources
-[Files](https://assets.01-edu.org/ai-branch/project5/home-credit-default-risk.zip)
+- [Interpreting machine learning models](https://towardsdatascience.com/interpretability-in-machine-learning-70c30694a05f)
diff --git a/subjects/ai/credit-scoring/audit/README.md b/subjects/ai/credit-scoring/audit/README.md
index 0c363cdd8..7eba4ec1f 100644
--- a/subjects/ai/credit-scoring/audit/README.md
+++ b/subjects/ai/credit-scoring/audit/README.md
@@ -5,7 +5,7 @@
```
project
│ README.md
-│ environment.yml
+│ requirements.txt
│
└───data
│ │ ...
@@ -38,7 +38,7 @@ project
###### Does the readme file introduce the project, summarize how to run the code and show the username?
-###### Does the environment contain all libraries used and the versions that are necessary to run the code?
+###### Does the requirements contain all libraries used and the versions that are necessary to run the code?
###### Does the `EDA.ipynb` explain in details the exploratory data analysis?
@@ -46,7 +46,7 @@ project
###### Is the model trained only the training set?
-###### Is the AUC on the test set higher than 75%?
+###### Is the AUC on the test set is between 55% (included) to 62%(included) or higher than 62%?
###### Does the model learning curves prove that the model is not overfitting?
@@ -59,7 +59,7 @@ project
```prompt
python predict.py
- AUC on test set: 0.76
+ AUC on test set: 0.62
```
@@ -75,11 +75,13 @@ This [article](https://medium.com/thecyphy/home-credit-default-risk-part-2-84b58
### Descriptive variables:
-###### These are important to understand for example the age of the client. If the data could be scaled or modified in the preprocessing pipeline but the data visualised here should be "raw". Are the visualisations computed for the 3 clients?
+##### These are important to understand for example the age of the client. If the data could be scaled or modified in the preprocessing pipeline but the data visualized here should be "raw".
- Visualisations that show at least 10 variables describing the client and its loan(s).
- Visualisations that show the comparison between this client and other clients.
+###### Are the visualisations computed for the 3 clients?
+
##### SHAP values on the model are displayed through a summary plot that shows the important features and their impact on the target. This is optional if you have already computed the features importance.
###### Are the 3 clients selected as expected? 2 clients from the train set (1 on which the model is correct and 1 on which the model's wrong) and 1 client from the test set.
diff --git a/subjects/ai/credit-scoring/readme_data.md b/subjects/ai/credit-scoring/readme_data.md
index 12aa9509c..8682b10e3 100644
--- a/subjects/ai/credit-scoring/readme_data.md
+++ b/subjects/ai/credit-scoring/readme_data.md
@@ -4,7 +4,7 @@ This file describes the available data for the project.
-## application_{train|test}.csv
+## application\_{train|test}.csv
This is the main table, broken into two files for Train (with TARGET) and Test (without TARGET).
Static data for all applications. One row represents one loan in our data sample.
@@ -17,24 +17,23 @@ For every loan in our sample, there are as many rows as number of credits the cl
## bureau_balance.csv
Monthly balances of previous credits in Credit Bureau.
-This table has one row for each month of history of every previous credit reported to Credit Bureau – i.e the table has (#loans in sample * # of relative previous credits * # of months where we have some history observable for the previous credits) rows.
+This table has one row for each month of history of every previous credit reported to Credit Bureau – i.e the table has (#loans in sample _ # of relative previous credits _ # of months where we have some history observable for the previous credits) rows.
## POS_CASH_balance.csv
Monthly balance snapshots of previous POS (point of sales) and cash loans that the applicant had with Home Credit.
-This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample * # of relative previous credits * # of months in which we have some history observable for the previous credits) rows.
+This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample _ # of relative previous credits _ # of months in which we have some history observable for the previous credits) rows.
## credit_card_balance.csv
Monthly balance snapshots of previous credit cards that the applicant has with Home Credit.
-This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample * # of relative previous credit cards * # of months where we have some history observable for the previous credit card) rows.
+This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample _ # of relative previous credit cards _ # of months where we have some history observable for the previous credit card) rows.
## previous_application.csv
All previous applications for Home Credit loans of clients who have loans in our sample.
There is one row for each previous application related to loans in our data sample.
-
## installments_payments.csv
Repayment history for the previously disbursed credits in Home Credit related to the loans in our sample.
diff --git a/subjects/ai/emotions-detector/README.md b/subjects/ai/emotions-detector/README.md
index a0bd99839..f95b70dee 100644
--- a/subjects/ai/emotions-detector/README.md
+++ b/subjects/ai/emotions-detector/README.md
@@ -1,10 +1,18 @@
-## Emotions detection with Deep Learning
+## Emotion detector
+
+### Overview
Cameras are everywhere. Videos and images have become one of the most interesting data sets for artificial intelligence.
Image processing is a quite broad research area, not just filtering, compression, and enhancement.
Besides, we are even interested in the question, “what is in images?”, i.e., content analysis of visual inputs, which is part of the main task of computer vision.
+### Role play
+
+you're going to train a computer to be like a mind reader, but instead of reading thoughts, it's reading emotions! You'll be working with a bunch of pictures of faces, teaching your AI to tell the difference between a big grin and a grumpy frown, or a surprised gasp and a fearful wide-eyed look.
+
+### Learning Objective
+
The study of computer vision could make possible such tasks as 3D reconstruction of scenes, motion capturing, and object recognition, which are crucial for even higher-level intelligence such as image and video understanding, and motion understanding.
For this project we will focus on two tasks:
@@ -18,7 +26,9 @@ With the computing power exponentially increasing the computer vision field has
- The history behind this field is fascinating! [Here](https://kapernikov.com/basic-introduction-to-computer-vision/) is a short summary of its history.
-### Project goal and suggested timeline
+### Instructions
+
+#### Project goal:
The goal of the project is to implement a **system that detects the emotion on a face from a webcam video stream**. To achieve this exciting task you'll have to understand how to:
@@ -32,7 +42,7 @@ Then starts the emotion detection in a webcam video stream step that will last u
The two steps are detailed below.
-### Preliminary:
+#### Preliminary:
- Take [this course](https://www.coursera.org/learn/convolutional-neural-networks). This course is a reference for many reasons and one of them is the creator: **Andrew Ng**. He explains the basics of CNNs but also some more advanced topics as transfer learning, siamese networks etc ...
- I suggest to focus on Week 1 and 2 and to spend less time on Week 3 and 4. Don't worry the time scoping of such MOOCs are conservative. You can attend the lessons for free!
@@ -41,7 +51,7 @@ The two steps are detailed below.
- Start first with a logistic regression to understand how to handle images in Python. And then train your first CNN on this data set.
-### Face emotions classification
+#### Face emotions classification
Emotion detection is one of the most researched topics in the modern-day machine learning arena. The ability to accurately detect and identify an emotion opens up numerous doors for Advanced Human Computer Interaction.
The aim of this project is to detect up to seven distinct facial emotions in real time.
@@ -57,7 +67,7 @@ Your goal is to implement a program that takes as input a video stream that cont
This dataset was provided for this past [Kaggle challenge](https://www.kaggle.com/competitions/challenges-in-representation-learning-facial-expression-recognition-challenge/overview).
It is possible to find more information about on the challenge page. Train a CNN on the dataset `train.csv`. Here is an [example of architecture](https://www.quora.com/What-is-the-VGG-neural-network) you can implement.
**The CNN has to perform more than 60% on the test set**. You can use the `test_with_emotions.csv` file for this. You will see that the CNNs take a lot of time to train.
- You don't want to overfit the neural network. I strongly suggest to use early stopping, callbacks and to monitor the training using the `TensorBoard`.
+ You don't want to overfit the neural network. I strongly suggest to use early stopping, callbacks and to monitor the training using the `TensorBoard` 'note: Integrating TensorBoard is not optional'.
You have to save the trained model in `final_emotion_model.keras` and to explain the chosen architecture in `final_emotion_model_arch.txt`. Use `model.summary())` to print the architecture.
It is also expected that you explain the iterations and how you end up choosing your final architecture. Save a screenshot of the `TensorBoard` while the model's training in `tensorboard.png` and save a plot with the learning curves showing the model training and stopping BEFORE the model starts overfitting in `learning_curves.png`.
@@ -82,7 +92,7 @@ For that step, I suggest again to use **OpenCV** as much as possible. This link
- Optional: **(very cool)** Hack the CNN. Take a picture for which the prediction of your CNN is **Happy**. Now, hack the CNN: using the same image **SLIGHTLY** modified make the CNN predict **Sad**.
You can find an example on how to achieve this in [this article](https://medium.com/@ageitgey/machine-learning-is-fun-part-8-how-to-intentionally-trick-neural-networks-b55da32b7196)
-### Deliverable
+### Project repository structure:
```
project
@@ -90,7 +100,7 @@ project
│ ├── test.csv
│ ├── train.csv
│ └── xxx.csv
-├── environment.yml
+├── requirements.txt
├── README.md
├── results
│ ├── model
@@ -148,14 +158,16 @@ Preprocessing ...
```
-### Useful resources:
+### Tips
+
+Balance technical prowess with psychological insight: as you fine-tune your CNN and optimize your video processing, remember that understanding the nuances of human facial expressions is key to creating a truly effective emotion detection system.
-- https://machinelearningmastery.com/what-is-computer-vision/
+### Resources
-- Use a pre-trained CNN: https://arxiv.org/pdf/1812.06387.pdf
+- [What is computer vision](https://machinelearningmastery.com/what-is-computer-vision/)
-- Hack the CNN https://medium.com/@ageitgey/machine-learning-is-fun-part-8-how-to-intentionally-trick-neural-networks-b55da32b7196
+- [Use a pre-trained CNN](https://arxiv.org/pdf/1812.06387.pdf)
-- http://ice.dlut.edu.cn/valse2018/ppt/WeihongDeng_VALSE2018.pdf
+- [Hack the CNN](https://medium.com/@ageitgey/machine-learning-is-fun-part-8-how-to-intentionally-trick-neural-networks-b55da32b7196)
-- https://arxiv.org/pdf/1812.06387.pdf
+- [Convolutional Neural Network](https://arxiv.org/pdf/1812.06387.pdf)
diff --git a/subjects/ai/emotions-detector/audit/README.md b/subjects/ai/emotions-detector/audit/README.md
index fe2a21df0..3fb9a7867 100644
--- a/subjects/ai/emotions-detector/audit/README.md
+++ b/subjects/ai/emotions-detector/audit/README.md
@@ -1,4 +1,4 @@
-#### Computer vision
+#### Emotion detector
##### Preliminary
@@ -14,7 +14,7 @@
###### Is the model trained only the training set?
-###### Is the accuracy on the test set higher than 70%?
+###### Is the accuracy on the test set higher than 60%?
###### Do the learning curves prove that the model is not overfitting?
diff --git a/subjects/ai/kaggle-titanic/README.md b/subjects/ai/kaggle-titanic/README.md
index 0f31e79a7..9e1c8f64c 100644
--- a/subjects/ai/kaggle-titanic/README.md
+++ b/subjects/ai/kaggle-titanic/README.md
@@ -1,6 +1,6 @@
-# Your first Kaggle: Titanic
+## Kaggle Titanic
-### Introduction
+### Overview
The goal of this **1 week** project is to get the highest possible score on a Data Science competition. More precisely you will have to predict who survived the Titanic crash.
@@ -8,11 +8,11 @@ The goal of this **1 week** project is to get the highest possible score on a Da
[titanic]: titanic.jpg "Titanic"
-### Kaggle
+#### Kaggle
Kaggle is an online community of data scientists and machine learning practitioners. Kaggle allows users to find and publish data sets, explore and build models in a web-based data-science environment, work with other data scientists and machine learning engineers, and enter competitions to solve data science challenges. It’s a crowd-sourced platform to attract, nurture, train and challenge data scientists from all around the world to solve data science, machine learning and predictive analytics problems.
-### Titanic - Machine Learning from Disaster
+#### Titanic - Machine Learning from Disaster
One of the first Kaggle competition I did was: Titanic - Machine Learning from Disaster. This is a not-to-be-missed Kaggle competition.
@@ -22,47 +22,28 @@ The sinking of the Titanic is one of the most infamous shipwrecks in history. On
While there was some element of luck involved in surviving, it seems some groups of people were more likely to survive than others.
-In this challenge, you have to build a predictive model that answers the question: **“what sorts of people were more likely to survive?”** using passenger data (ie name, age, gender, socio-economic class, etc). **You will have to submit your prediction on Kaggle**.
-
-### Preliminary
-
-The way the Kaggle platform works is explained in the challenge overview page. If you need more details, I suggest this [resource](https://towardsdatascience.com/getting-started-with-kaggle-f9138b35ae18) that gives detailed explanations.
-
-- Create a username following this structure: username*01EDU* location_MM_YYYY. Submit the description profile and push it on GitHub the first day of the week. Do not touch this file anymore.
-
-- It is possible to have different personal accounts merged in a team for one single competition.
+### Role play
-### Deliverables
+Ahoy, data explorer! Ready to set sail on the most thrilling voyage of your data science career? Welcome aboard the Kaggle Titanic challenge! You're about to embark on a journey through time, back to that fateful night in 1912.
+Your mission, should you choose to accept it (and let's face it, you're already hooked), is to dive deep into the passenger manifest and uncover the secrets of survival. Who lived? Who perished? And most importantly, can you build a model that predicts it all?
-```console
-project
-│ README.md
-│ environment.yml
-│ username.txt
-│
-└───data
-│ │ train.csv
-│ | test.csv
-| | gender_submission.csv
-│
-└───notebook
-│ │ main.ipynb
+### Learning Objective
+In this challenge, you have to build a predictive model that answers the question: **“what sorts of people were more likely to survive?”** using passenger data (ie name, age, gender, socio-economic class, etc). **You will have to submit your prediction on Kaggle**.
-```
+### Instructions
-- `README.md` introduction of the project, shows the username, describes the features engineering and the best score on the **leaderboard**. Note the score on the test set using the exact same pipeline that led to the best score on the leaderboard.
+#### Preliminary
-- `environment.yml` contains all libraries required to run the code.
+The way the Kaggle platform works is explained in the challenge overview page. If you need more details, I suggest this [resource](https://www.kaggle.com/code/alexisbcook/getting-started-with-kaggle) that gives detailed explanations.
-- `username.txt` contains the username, the last modified date of the file **has to correspond to the first day of the project**.
+- Create a username following this structure: username*01EDU* location_MM_YYYY. Submit the description profile and push it on GitHub the first day of the week. Do not touch this file anymore.
-- `main.ipynb` This file (single Jupyter Notebook) should contain all steps of data analysis that contributed or not to improve the accuracy, the feature engineering, the model's training and prediction on the test set. It has to be commented to help the reviewers understand the approach and run the code without any bugs.
-- **Submit your predictions on the Kaggle's competition platform**. Check your ranking and score in the leaderboard.
+- It is possible to have different personal accounts merged in a team for one single competition.
-### Scores
+#### Scores
-In order to validate the project you will have to score at least **79% accuracy on the Leaderboard**:
+In order to validate the project you will have to score at least **78.9% accuracy on the Leaderboard**:
- 78.9% accuracy is the minimum score to validate the project.
@@ -75,20 +56,48 @@ Scores indication:
#### Cheating
-It is impossible to get 100%. Who would have predicted that Rose wouldn't let [Jack on the door](https://www.insider.com/jack-and-rose-werent-on-a-door-in-titanic-2019-7) ?
+It is impossible to get 100%. Who would have predicted that Rose wouldn't let [Jack on the door](https://www.reddit.com/r/titanic/comments/14i0v5j/for_all_the_newbies_proof_its_not_a_door/?rdt=35268) ?
All people having 100% of accuracy on the Leaderboard cheated, there's no point to compare with them or to cheat. The Kaggle community estimates that having more than 85% is almost considered as cheated submissions as they are element of luck involved in the surviving.
**You can't use external data sets than the ones provided in that competition.**
-### The key points
+#### The key points
- **Feature engineering**:
Put yourself in the shoes of an investigator trying to understand what happened exactly in that boat during the crash. Do not hesitate to watch the movie to try to find as many insights as possible. Without a smart the feature engineering there's no way to validate the project ;-)
- The leaderboard evaluates on test data for which you don't have the labels. It means that there's no point to over fit the train set. Check the over fitting on the train set by dividing the data and by cross-validating the accuracy.
-### Advice
+### Project repository structure
+
+```console
+project
+│ README.md
+│ requirements.txt
+│ username.txt
+│
+└───data
+│ │ train.csv
+│ | test.csv
+| | gender_submission.csv
+│
+└───notebook
+│ │ main.ipynb
+
+
+```
+
+- `README.md` introduction of the project, shows the username, describes the features engineering and the best score on the **leaderboard**. Note the score on the test set using the exact same pipeline that led to the best score on the leaderboard.
+
+- 'requirements.txt` contains all libraries required to run the code.
+
+- `username.txt` contains the username, the last modified date of the file **has to correspond to the first day of the project**.
+
+- `main.ipynb` This file (single Jupyter Notebook) should contain all steps of data analysis that contributed or not to improve the accuracy, the feature engineering, the model's training and prediction on the test set. It has to be commented to help the reviewers understand the approach and run the code without any bugs.
+- **Submit your predictions on the Kaggle's competition platform**. Check your ranking and score in the leaderboard.
+
+### Tips
Don't try to build the perfect model the first day. Iterate a lot and test your assumptions:
diff --git a/subjects/ai/kaggle-titanic/audit/README.md b/subjects/ai/kaggle-titanic/audit/README.md
index 78dda58e1..363b2bcad 100644
--- a/subjects/ai/kaggle-titanic/audit/README.md
+++ b/subjects/ai/kaggle-titanic/audit/README.md
@@ -1,4 +1,4 @@
-#### First Kaggle: Titanic
+#### Kaggle Titanic
##### Preliminary
@@ -43,7 +43,7 @@ project
#### Final score
-###### Is the accuracy associated with the username in `username.txt` higher than 79%? The best submission score can be accessed from the user profile.
+###### Is the accuracy associated with the username in `username.txt` higher than 78.9%? The best submission score can be accessed from the user profile.
#### Examples
diff --git a/subjects/ai/nlp-scraper/README.md b/subjects/ai/nlp-scraper/README.md
index b7c1741fc..71209fb80 100644
--- a/subjects/ai/nlp-scraper/README.md
+++ b/subjects/ai/nlp-scraper/README.md
@@ -1,4 +1,4 @@
-## NLP-enriched News Intelligence platform
+## NLP Scraper
The goal of this project is to build an NLP-enriched News Intelligence
platform. News analysis is a trending and important topic. The analysts get
@@ -10,7 +10,25 @@ The platform connects to a news data source, detects the entities, detects the
topic of the article, analyses the sentiment and performs a scandal detection
analysis.
-### Scraper
+### Role Play
+
+You're a Natural Language Processing (NLP) specialist at a tech startup developing a sentiment analysis tool for social media posts. Your task is to build the preprocessing pipeline and create a bag-of-words representation for tweet analysis.
+
+### Learning Objectives
+
+1. Set up an NLP-focused Python environment
+2. Implement basic text preprocessing techniques (lowercase, punctuation removal)
+3. Perform text tokenization at sentence and word levels
+4. Remove stop words from text data
+5. Apply stemming to reduce words to their root forms
+6. Create a complete text preprocessing pipeline
+7. Implement a bag-of-words model using CountVectorizer
+8. Analyze word frequency in a corpus of tweets
+9. Prepare a labeled dataset for sentiment analysis
+
+### Instructions
+
+#### Scraper
News data source:
@@ -29,7 +47,7 @@ Use data from the last week otherwise the volume may be too high.
There should be at least 300 articles stored in your file system or SQL
database.
-### NLP engine
+#### NLP engine
In production architectures, the NLP engine delivers a live output based on the
news that are delivered in a live stream data by the scraper. However, it
@@ -41,7 +59,7 @@ the stored data.
Here how the NLP engine should process the news:
-#### **1. Entities detection:**
+##### **1. Entities detection:**
The goal is to detect all the entities in the document (headline and body). The
type of entity we focus on is `ORG`. This corresponds to companies and
@@ -52,7 +70,7 @@ organizations. This information should be stored.
[Named Entity Recognition with NLTK and
SpaCy](https://towardsdatascience.com/named-entity-recognition-with-nltk-and-spacy-8c4a7d88e7da)
-#### **2. Topic detection:**
+##### **2. Topic detection:**
The goal is to detect what the article is dealing with: Tech, Sport, Business,
Entertainment or Politics. To do so, a labelled dataset is provided: [training
@@ -68,7 +86,7 @@ that the model is trained correctly and not overfitted.
- Learning constraints: **Score on test: > 95%**
-#### **3. Sentiment analysis:**
+##### **3. Sentiment analysis:**
The goal is to detect the sentiment (positive, negative or neutral) of the news
articles. To do so, use a pre-trained sentiment model. I suggest to use:
@@ -82,7 +100,7 @@ articles. To do so, use a pre-trained sentiment model. I suggest to use:
- [Sentiment analysis](https://en.wikipedia.org/wiki/Sentiment_analysis)
-#### **4. Scandal detection**
+##### **4. Scandal detection**
The goal is to detect environmental disaster for the detected companies. Here
is the methodology that should be used:
@@ -107,7 +125,7 @@ is the methodology that should be used:
- Flag the top 10 articles.
-#### 5. **Source analysis (optional)**
+##### 5. **Source analysis (optional)**
The goal is to show insights about the news' source you scraped.
This requires to scrap data on at least 5 days (a week ideally). Save the plots
@@ -127,7 +145,7 @@ Here are examples of insights:
- Companies mentioned the most
- Sentiment per companies
-### Deliverables
+### Project repository structure:
The expected structure of the project is:
@@ -137,6 +155,7 @@ project
├── data
│ └── ...
├── nlp_enriched_news.py
+├── requirements.txt
├── README.md
├── results
│ ├── training_model.py
@@ -212,7 +231,7 @@ python scraper_news.py
Environmental scandal detected for
```
-### Notions
+### Resources
- [Web Scraping](https://www.youtube.com/watch?v=XVv6mJpFOb0)
- [Sentiment analysis](https://en.wikipedia.org/wiki/Sentiment_analysis)
diff --git a/subjects/ai/nlp-scraper/audit/README.md b/subjects/ai/nlp-scraper/audit/README.md
index e38aa8144..225dbeba4 100644
--- a/subjects/ai/nlp-scraper/audit/README.md
+++ b/subjects/ai/nlp-scraper/audit/README.md
@@ -1,4 +1,4 @@
-#### NLP-enriched News Intelligence platform
+#### NLP Scraper
##### Preliminary
diff --git a/subjects/ai/sp500-strategies/README.md b/subjects/ai/sp500-strategies/README.md
index b7d88c1ab..71e0767ee 100644
--- a/subjects/ai/sp500-strategies/README.md
+++ b/subjects/ai/sp500-strategies/README.md
@@ -1,4 +1,6 @@
-## Financial strategies on the SP500
+## SP500 strategies
+
+### Overview
In this project, you'll apply machine learning to finance. Your goal as a Quant/Data Scientist is to create a financial strategy that uses a signal generated by a machine learning model to outperform the [SP500](https://en.wikipedia.org/wiki/S%26P_500).
@@ -6,15 +8,19 @@ The S&P 500 Index is a collection of 500 stocks that represent the overall perfo
The S&P 500 started in 1926 with only 90 stocks and has grown to include 500 stocks since 1957. Historically, the average annual return of the S&P 500 has been about 10-11% since 1926, and around 8% since 1957.
+### Role play
+
As a Quantitative Researcher, your challenge is to develop a strategy that can consistently outperform the S&P 500, not just in one year, but over many years. This is a difficult task and is the primary goal of many hedge funds around the world.
-The project is divided in parts:
+### Learning Objective
- **Data processing and feature engineering**: Build a dataset: insightful features and the target
- **Machine Learning pipeline**: Train machine learning models on the dataset, select the best model and generate the machine learning signal.
- **Strategy backtesting**: Generate a strategy from the Machine Learning model output and backtest the strategy. As a reminder, the idea here is to see what would have performed the strategy if you had invested.
-### Data processing and features engineering
+### Instructions
+
+#### Data processing and features engineering
The file `HistoricalData.csv` contains the open-high-low-close (OHLC) SP500 index data and the other file, `all_stocks_5yr.csv`, contains the open-high-low-close-volume (OHLCV) data on the SP500 constituents.
@@ -42,7 +48,7 @@ We assume it is day `D`, and we want to take a position on the next n days. The
> Remark: The target used is the return computed on the price and not the price directly. There are statistical reasons for this choice - the price is not stationary. The consequence is that a machine learning model tends to overfit while training on not stationary data.
-### Machine learning pipeline
+#### Machine learning pipeline
- Cross-validation deliverables:
- Implements a cross validation with at least 10 folds. The train set has to be bigger than 2 years history.
@@ -80,7 +86,7 @@ Once you'll have run the grid search on the cross validation (choose either Bloc
- (optional): [Train an RNN/LSTM](https://towardsdatascience.com/predicting-stock-price-with-lstm-13af86a74944). This is a nice way to discover and learn about recurrent neural networks. But keep in mind that there are some new neural network architectures that seem to outperform recurrent neural networks. Here is an [interesting article](https://towardsdatascience.com/the-fall-of-rnn-lstm-2d1594c74ce0) about the topic.
-### Strategy backtesting
+#### Strategy backtesting
- Backtesting module deliverables. The module takes as input a machine learning signal, convert it into a financial strategy. A financial strategy DataFrame gives the amount invested at time `t` on asset `i`. The module returns the following metrics on the train set and the test set.
- Profit and Loss (PnL) plot: save it as `strategy.png`
@@ -107,7 +113,7 @@ Once you'll have run the grid search on the cross validation (choose either Bloc
- PnL plot
- strategy metrics on the train set and test set
-### Example of strategies:
+#### Example of strategies:
- Long only:
- Binary signal:
@@ -172,7 +178,7 @@ Here's an example on how to convert a machine learning signal into a financial s
project
├── data
│ └── sp500.csv
-├── environment.yml
+├── requirements.txt
├── README.md
├── results
│ ├── cross-validation
@@ -199,7 +205,10 @@ project
Note: `features_engineering.py` can be used in `gridsearch.py`
-### Files for this project
+### Tips
+
+Remember, the goal of this project is not just to beat the S&P 500 in a backtest, but to learn about the process of developing and testing trading strategies using machine learning techniques.
+
+### Resources
-You can find the data required for this project in this :
-[link](https://assets.01-edu.org/ai-branch/project4/project04-20221031T173034Z-001.zip)
+You can find the data required for this project in this : [link](https://assets.01-edu.org/ai-branch/project4/project04-20221031T173034Z-001.zip)
diff --git a/subjects/ai/sp500-strategies/audit/README.md b/subjects/ai/sp500-strategies/audit/README.md
index 5c5b361d4..499436301 100644
--- a/subjects/ai/sp500-strategies/audit/README.md
+++ b/subjects/ai/sp500-strategies/audit/README.md
@@ -1,4 +1,4 @@
-#### Financial strategies on the SP500
+#### SP500 strategies
###### Is the structure of the project like the one presented in the `Project repository structure` in the subject?
diff --git a/subjects/cybersecurity/image-inspector/README.md b/subjects/cybersecurity/image-inspector/README.md
index 777233ece..7a6a2d936 100644
--- a/subjects/cybersecurity/image-inspector/README.md
+++ b/subjects/cybersecurity/image-inspector/README.md
@@ -13,7 +13,7 @@ Images can contain more than just visual information, they often carry hidden da
The goal is to develop a tool using a programming language of your choice (Python is recommended) that can analyze images to extract hidden information. Specifically, your tool should:
1. **Extract Metadata**: Identify and display metadata from images, such as geolocation (latitude and longitude) where the photo was taken, the device used, and other relevant information.
-2. **Detect Steganography**: Discover and extract any hidden PGP keys or other data concealed within the image using steganography techniques.
+2. **Detect Steganography**: Discover and extract any hidden PGP keys within the image using steganography techniques.
By completing this project, you will:
@@ -101,7 +101,7 @@ Data saved in hidden_data.txt
```
**You will be provided with an example image to test your tool. Make sure your tool can successfully analyze this image and produce the expected outputs.**
-The example image attached:
+The example image attached:
[image-example1.jpeg](resources/image-example1.jpeg)
[image-example2.jpeg](resources/image-example2.jpeg)
[image-example3.jpeg](resources/image-example3.jpeg)
diff --git a/subjects/cybersecurity/image-inspector/audit/README.md b/subjects/cybersecurity/image-inspector/audit/README.md
index 03ad9adce..a31b381e1 100644
--- a/subjects/cybersecurity/image-inspector/audit/README.md
+++ b/subjects/cybersecurity/image-inspector/audit/README.md
@@ -22,8 +22,6 @@ Suggested role play questions include:
- How can this tool be used in real-life digital forensics or cybersecurity scenarios?
- What ethical considerations should be taken into account when analyzing images for hidden data?
-###### Were the students able to answer all the questions?
-
###### Did the students demonstrate a thorough understanding of the concepts and technologies used in the project?
###### Were the students able to communicate effectively and justify their decisions and explain the knowledge behind this project?
@@ -64,14 +62,14 @@ $> image-inspector -m -o metadata.txt image-example1.jpeg
$> image-inspector -s -o hidden_data.txt image-example1.jpeg
```
-###### Does the output correctly detect and extract any hidden PGP keys or other concealed information within the image?
+###### Does the output correctly detect and extract any hidden PGP keys within the image?
###### Is the output stored in the file specified in the output parameter?
##### Testing with Images
**You will be provided with an example image to test the students tool. Feel free to test with other images.**
-The example image attached:
+The example image attached:
[image-example1.jpeg](resources/image-example1.jpeg)
[image-example2.jpeg](resources/image-example2.jpeg)
[image-example3.jpeg](resources/image-example3.jpeg)
@@ -79,18 +77,47 @@ The example image attached:
###### Test the tool with the provided example image and at least one other image to ensure the tool's robustness.
-###### Does the tool produce accurate and expected results for different images?
+```sh
+$> image-inspector -s -o hidden_data1.txt image-example1.jpeg
+Enter -----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: 01
+
+mQENBGIwpy4BC<...>
+=N8hc
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
+
+```sh
+$> image-inspector -s -o hidden_data2.txt image-example2.jpeg
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+xo0EZuV9/AEEANRklh3<...>
+=BhsK
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
-##### Ensure that the student submission meets the project requirements:
+```sh
+$> image-inspector -s -o hidden_data3.txt image-example3.jpeg
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+xo0EZuWBWQEEALrj<...>
+=SXXm
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
-1. **Functionality:** Does the tool perform its intended functions accurately (metadata extraction and steganography detection)?
-2. **Data Accuracy:** Is the retrieved information accurate and relevant?
-3. **Ethical Considerations:** Are there clear guidelines and warnings about the ethical and legal use of the tool?
-4. **Usability:** Is the tool user-friendly and well-documented?
+```sh
+$> image-inspector -s -o hidden_data4.txt image-example4.jpeg
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+xo0EZuWA9AE<...>
+=/1dE
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
-###### Did the tool design and implementation align with all the project requirements above?
+> The results are cut. you can compare the beginning and the end of the results!
-###### Were the students able to implement a functional and reliable tool that meets the project requirements?
+###### Does the tool produce accurate and expected results for different images?
#### Bonus
diff --git a/subjects/devops/serverless/README.md b/subjects/devops/serverless/README.md
new file mode 100644
index 000000000..e7f06408e
--- /dev/null
+++ b/subjects/devops/serverless/README.md
@@ -0,0 +1,159 @@
+## Serverless Payments Reminder
+
+Serverless Payments Reminder is a basic Slack Bot that reminds companies / users to pay their bills. The reminder gets triggered by AWS EventBridge (also known as CloudWatch Events). The bot itself is hosted on a simple AWS Lambda function.
+
+### Requirements for the task
+
+Create a simple Slack bot using:
+
+- [AWS](https://aws.amazon.com/)
+- [Serverless Framework](https://serverless.com/)
+- [Cloudformation](https://aws.amazon.com/cloudformation/)
+- [Terraform](https://www.terraform.io/)
+
+### Task
+
+The task is separated into multiple different levels. The levels are ordered by complexity. You can choose the level that you feel most comfortable with.
+
+## Level 0: Basic Lambda Function hosted via Serverless
+
+**1. Create Slack Bot**
+
+Write a slack bot, that sends a reminder to slack channel with the following message:
+
+```sh
+Dear Board Members! This is a reminder to make the payment for the licenses of the software. The due date is 07.XX.YY, where XX is the month and YY is the year. The amount to be paid is $ZZZ.VV. Please make the payment as soon as possible to . Thank you!
+```
+
+The environment variables which must be available in the Lambda function are:
+
+- `SLACK_WEBHOOK_URL` - The Slack Webhook URL
+- `AMOUNT` - The amount to be paid
+- `IBAN_NUMBER` - The IBAN number
+
+The due date must be calculated based on the current date for the next month.
+
+Before step two, you need to test that Slack Bot is functioning properly by running an application locally. It should send a message to the Slack channel.
+
+**2. Write tests for the application**
+
+Write integration tests for the application to ensure that each part of the application is functioning properly.
+
+**3. Use [Serverless Framework](https://github.com/serverless/serverless) to host the lambda function**
+
+Serverless framework is an automation tool used to deploy serverless applications which can help with event-driven architecture deployments.
+
+Use the serverless framework to host the lambda function combined with AWS Eventbridge.
+
+**Refs**
+
+- [AWS EventBridge](https://www.serverless.com/framework/docs/providers/aws/events/event-bridge)
+- [AWS Lambda Function](https://www.serverless.com/framework/docs/providers/aws/guide/functions).
+
+AWS Eventbridge should trigger lambda function every month on the 1st day of the month at 10:00 AM.
+
+**Note** Before hosting, you need to ensure that the bot is written in a way that it can be hosted on AWS Lambda. You can look at the example [here](https://github.com/KostLinux/aws-incident-manager-notifier/blob/56d52e90f8a14e689e7d2a1c7ee44590de5af2f5/main.go#L158).
+
+## Level 1: Basic Lambda Function automation via Cloudformation
+
+**1. Repeat the 1st and 2nd step from Level 0**
+
+Create a slack bot, that sends a reminder to slack channel. Write integration tests for the application to ensure that each part of the application is functioning properly.
+
+**Note** Don't forget to add Lambda handler for the application
+
+**2. Use [Cloudformation](https://aws.amazon.com/cloudformation/) to host the lambda function**
+
+Cloudformation is Infrastructure As Code (IaC) tool used to automate the provisioning of AWS resources inside the AWS. It allows you to use a simple yaml syntax to define the resources you want to create.
+
+**2.1 Hosting the Lambda function**
+
+Write cloudformation template with parameters (variables) `SlackWebhookUrl`, `Amount`, `IbanNumber`. The template should automatically provision the Slackbot based on architecture mentioned in Level 0 step 3.
+
+## Level 2: Basic Lambda Function automation via Basic Terraform with Local State
+
+Terraform is an Infrastructure As Code (IaC) tool used to automate the provisioning of resources inside different SaaS solutions and Cloud providers. It uses HCL syntax, which is easy maintainable. The main problem of terraform is that you need to know, how everything works under the hood (e.g. IAM roles, policies, serverless platforms etc).
+
+**1. Repeat the 1st and 2nd step from Level 0**
+
+Create a slack bot, that sends a reminder to slack channel. Write integration tests for the application to ensure that each part of the application is functioning properly.
+
+**Note** Don't forget to add Lambda handler for the application
+
+**2. Automate the hosting via Terraform**
+
+**2.1 Write an IAM role with the least privilege principle for the lambda function and EventBridge.**
+
+**2.2 Automatically pack up the lambda function into a zip file**
+
+**2.3 Build the lambda function based on the zip file**
+
+**2.4 Build AWS Eventbridge, which will trigger the lambda function**
+
+**Note** Lambda function should be triggered every month on the 1st day of the month at 10:00 AM.
+
+At this level you can use local state for terraform, no modules needed to write.
+
+## Level 3: Basic Lambda Function automation via Terraform Module with Remote S3 State (advanced)
+
+In a DevOps world, mostly we use remote state for terraform. The main reason is that we can share the state with other team members and we can easily manage the state of the infrastructure. Although it is a bit more complex to set up, it allows you to avoid issues when someone even removes the state file, cause S3 has versioning turned on.
+
+This level is more advanced, but more near to the real-world scenario. As a DevOps Engineer / SRE mostly all the terraform code is written in modules (or using community pre-built modules). Modules help us to maintain the codebase and reuse the code in different projects, so you don't need to write the same code again and again.
+
+**1. Repeat the steps from Level 2**
+
+Repeat all the steps from Level 2, but now you need to write a terraform module for the lambda function and EventBridge. Which means that instead of writing values directly into main.tf file, everything should be written using variables. For example:
+
+```tf
+resource "aws_lambda_function" "slack_bot" {
+ function_name = var.function_name
+ role = var.role
+ handler = var.handler
+ runtime = var.runtime
+ timeout = var.timeout
+}
+```
+
+We're using variables for each value, so we can reuse the module in different projects.
+
+**2. Use remote state for terraform**
+
+In this step you need to configure IAM User with least privilege principle for terraform to access S3 bucket, provision resources in Eventbridge and Lambda function.
+
+**Note** We would recommend using [Cloudformation](https://aws.amazon.com/cloudformation/) to create an IAM User with the least privilege principle + S3 Bucket for the remote state. Cloudformation can be applied via AWS CLI which means that everything persists to be AS CODE.
+
+**3. Use the S3 bucket for the remote state and module to provision the resources**
+
+Write your backend configuration to backend.tf file:
+
+```tf
+terraform {
+ backend "s3" {
+ bucket = ""
+ key = ""
+ region = ""
+ encrypt = ""
+ }
+}
+```
+
+Use the module written at step 1 to provision the resources
+
+```tf
+module "slack_bot" {
+ source = "./modules/slack_bot"
+ function_name = "slack_bot"
+ role = "arn:aws:iam::123456789012:role/lambda-role"
+ handler = "main.handler"
+ runtime = "nodejs14.x"
+ timeout = 10
+}
+```
+
+## Helpful commands
+
+- `serverless deploy` - Deploy the serverless application
+- `aws cloudformation deploy --template-file template.yaml --stack-name my-stack` - Deploy the cloudformation stack
+- `terraform init` - Initialize the terraform project and remote state.
+- `terraform plan` - Plan the resources you're going to provision. It will show you the changes that will be made.
+- `terraform apply` - Apply the terraform project only if you're sure that everything is correct during the plan.
diff --git a/subjects/devops/serverless/backend.tf b/subjects/devops/serverless/backend.tf
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/devops/serverless/cloudformation/.gitkeep b/subjects/devops/serverless/cloudformation/.gitkeep
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/devops/serverless/main.tf b/subjects/devops/serverless/main.tf
new file mode 100644
index 000000000..45f3691d2
--- /dev/null
+++ b/subjects/devops/serverless/main.tf
@@ -0,0 +1,3 @@
+module "aws_slack_bot" {
+ source = "./modules/aws_slack_bot"
+}
\ No newline at end of file
diff --git a/subjects/devops/serverless/modules/aws_slack_bot/.gitkeep b/subjects/devops/serverless/modules/aws_slack_bot/.gitkeep
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/devops/serverless/modules/aws_slack_bot/bot/.gitkeep b/subjects/devops/serverless/modules/aws_slack_bot/bot/.gitkeep
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/gaming/2-5-d-adventure/README.md b/subjects/gaming/2-5-d-adventure/README.md
new file mode 100644
index 000000000..718af1717
--- /dev/null
+++ b/subjects/gaming/2-5-d-adventure/README.md
@@ -0,0 +1,148 @@
+## 2.5D Adventure
+
+### Overview
+
+This project involves creating a simple 2.5D side-scroller game designed to introduce you to the fundamentals of Unreal Engine 5 and game development, without the complexity of advanced mechanics. It focuses on the essential skills and concepts needed to start your journey as a game developer.
+
+
+
+
+
+### Role play
+
+You've just embarked on your journey into game development, choosing `Unreal Engine 5` as your primary tool. Excited by the possibilities, you decide to create a simple 2.5D game as your first project. However, as you dive into the engine, you realize there's a vast array of tools and features you've never encountered before. Now, you're tasked with navigating this uncharted territory, learning new skills in level design, scripting, and asset management to bring your game to life.
+
+### Learning Objective
+
+At the end of this project you will have learned:
+
+- Setting up a basic player character (input handling, movement, camera, etc.)
+- Basic scripting (`Blueprints` and/or `C++`).
+- Collision detection.
+- Object creation and `instancing`.
+- Basic UI/HUD.
+- Basic level design
+- Game logic and flow (Game Loops).
+
+### Instructions
+
+#### General
+
+The use of `event dispatchers` is mandatory throughout the project, any code coupling will be disqualified.
+
+> Tip: look for the observer pattern.
+
+Your game should follow a coherent `theme` of your choice, whether it's a dark fantasy, sci-fi, or something entirely different. Let your imagination guide you.
+
+> Note: the resources section will list some places where you can browse assets.
+
+> Tip: For maximum learning, it is recommended to start this project with a blank Unreal project and implement everything from scratch.
+
+#### Main Menu
+
+The main menu `widget` should:
+
+- Be on a separate `level/map` from the `main game` map.
+- Contain two buttons:
+ - Start game button.
+ - Exit game button.
+
+#### Player Character
+
+The player `character` should:
+
+- Have a skeletal mesh.
+- Move only along two axes: left-right and up-down.
+- Have a basic locomotion system with the following animations:
+ - `Idle`.
+ - `Walking`.
+ - `Running`.
+ - `Jumping`.
+ - `Falling`.
+ - `Landing`.
+- Transition smoothly between a walking and running animations based on their speed.
+
+
+
+
+> Tip: Look into the best practices for creating a locomotion system, Animation blueprints and Blend spaces.
+
+#### Collectible
+
+The collectible `Actor` should:
+
+- Have a static mesh.
+- Rotate around an axis of your choice.
+- Have a box collider that acts like a trigger.
+- Be collected when the player enters its box trigger.
+- Play a sound when collected
+
+
+
+
+#### HUD
+
+The HUD `widget` should:
+
+- Display a value related to the `collectible`.
+- Be updated each time a `collectible` is picked up.
+
+
+
+
+#### Enemy
+
+The enemy `character` should:
+
+- Have a skeletal mesh.
+- Have at least a walking cycle.
+- Have a simple AI that patrols between two set points.
+- Kill the player on collision.
+- Be killed if the player lands on top of it.
+- Play a sound when killed.
+- create an instance of `Collectible` at the place of death.
+ > Note: Make sure the instance of collectible spawned from killing an enemy also updates the HUD.
+
+
+
+ 
+ 
+
+
+
+#### Game Loop Logic
+
+The game loop consists of a spawn point where the player `starts` and `respawns` when dead.
+And an end point that defines the player goal to finish the level.
+When the player reaches the end point:
+
+- a menu with options to `restart` or `quit` the game should be displayed.
+
+#### Level design
+
+Your level design shouldn't consist of just a long, empty run to the finish point. However, since creating a level is a creative process, you have the freedom to design it as you see fit. For example, you can include moving platforms or skill-based platforming elements. The choice is yours to provide the player with a fun and challenging experience.
+
+> Tip: look at other games from a similar genre for inspiration.
+> 
+
+
+
+### Bonus
+
+- Add a health system to both the player character and the enemy character. (look into `Components`)
+- Add a simple crouch to your locomotion system.
+- more mechanics as you see fit for your game.
+- Create a simple `Game Design Document` where you describe your mechanics and how are you planning to implement them.
+
+### Submission
+
+- In your repository there should be a zip file of a build of your game for your target platform.
+ > If it is not possible to upload files to Gitea due to their size, use GitHub instead and have a look at [Git LSF](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)
+
+### Resources
+
+- [Animation Blueprints](https://dev.epicgames.com/documentation/en-us/unreal-engine/animation-blueprints-in-unreal-engine)
+- [Actor Components](https://dev.epicgames.com/documentation/en-us/unreal-engine/components-in-unreal-engine)
+- [Mixamo for animations and character models](https://www.mixamo.com/)
+- [SketchFab for 3D models](https://sketchfab.com/)
+- [itch.io for more assets](https://itch.io/)
diff --git a/subjects/gaming/2-5-d-adventure/audit/README.md b/subjects/gaming/2-5-d-adventure/audit/README.md
new file mode 100644
index 000000000..c370d859d
--- /dev/null
+++ b/subjects/gaming/2-5-d-adventure/audit/README.md
@@ -0,0 +1,89 @@
+> Due to file size reason, the solution might be uploaded on GitHub instead of Gitea!
+
+#### General
+
+##### If, at any point during the audit, coupled code is detected that could have been resolved using the Observer pattern (`event dispatchers`), the audit will stop, and the student will fail the project.
+
+###### Is the game following a coherent theme ?
+
+#### Main Menu
+
+###### Is the main menu widget on a separate level/map from the main game map?
+
+###### Does the main menu contain a Start game button?
+
+###### Does the main menu contain an Exit game button?
+
+#### Player Character
+
+###### Does the player character have a skeletal mesh?
+
+###### Can the player character move only along two axes: left-right and up-down?
+
+###### Does the player character have a basic locomotion system with all the required animations?
+
+###### Does the player character transition smoothly between walking and running animations based on their speed?
+
+#### Collectible
+
+###### Does the collectible Actor have a static mesh?
+
+###### Does the collectible rotate around an axis?
+
+###### Does the collectible have a box collider that acts as a trigger?
+
+###### Is the collectible collected when the player enters its box trigger?
+
+###### Does the collectible play a sound when collected?
+
+#### HUD
+
+###### Does the HUD widget display a value related to the `collectible`?
+
+###### Is the HUD updated each time a `collectible` is picked up?
+
+###### Is the HUD also updated when picking a `collectible` that spawned from killing an enemy?
+
+#### Enemy
+
+###### Does the enemy character have a skeletal mesh?
+
+###### Does the enemy character have at least a walking cycle?
+
+###### Does the enemy character have a simple AI that patrols between two set points?
+
+###### Does the enemy character kill the player on collision?
+
+###### Is the enemy character killed if the player lands on top of it?
+
+###### Does the enemy character play a sound when killed?
+
+###### Does the enemy character create an instance of a `Collectible` at the place of death?
+
+#### Game loop
+
+###### Is there a spawn point where the player starts?
+
+###### Does the player respawn at the spawn point when dead?
+
+###### Is there an end point that defines the player’s goal to finish the level?
+
+###### When the player reaches the end point, is a menu displayed with options to restart or quit the game?
+
+#### Level design
+
+###### Does the level design avoid being just a long, empty run to the finish point?
+
+###### Does the level include mechanics chosen by the student? `(e.g. moving platforms skill-based platforming)`
+
+###### Does the level provide a fun and challenging experience for the player?
+
+#### Bonus
+
+###### +Has a health system been added to both the player character and the enemy character using Components?
+
+###### +Has a simple crouch been added to the player character's locomotion system?
+
+###### +Have additional mechanics been implemented to fit the overall game design?
+
+###### +Has a simple Game Design Document been created that describes the mechanics and outlines the plan for implementing them?
diff --git a/subjects/gaming/2-5-d-adventure/resources/1.jpg b/subjects/gaming/2-5-d-adventure/resources/1.jpg
new file mode 100755
index 000000000..4222cc2e3
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/1.jpg differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/collectible.gif b/subjects/gaming/2-5-d-adventure/resources/collectible.gif
new file mode 100755
index 000000000..dbf91d293
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/collectible.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/enemydie.gif b/subjects/gaming/2-5-d-adventure/resources/enemydie.gif
new file mode 100755
index 000000000..62ec093dc
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/enemydie.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif b/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif
new file mode 100755
index 000000000..dedd1cb95
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/hud.gif b/subjects/gaming/2-5-d-adventure/resources/hud.gif
new file mode 100755
index 000000000..904d0cdfc
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/hud.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/locomotion.gif b/subjects/gaming/2-5-d-adventure/resources/locomotion.gif
new file mode 100755
index 000000000..b8de0e007
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/locomotion.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/platformer.jpg b/subjects/gaming/2-5-d-adventure/resources/platformer.jpg
new file mode 100755
index 000000000..52c4ff8e9
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/platformer.jpg differ
diff --git a/subjects/gaming/firing-range/README.md b/subjects/gaming/firing-range/README.md
index 4775ebc60..6fdd1c1f1 100644
--- a/subjects/gaming/firing-range/README.md
+++ b/subjects/gaming/firing-range/README.md
@@ -1,39 +1,125 @@
-## FiringRange
+## Firing-range
-In this exercise, you will learn to use the Unreal Engine and Blueprints to script functionalities of a basic FPS game. The theme is to reproduce a firing range. And remember, weapons are allowed only inside the shooting area!!
+### Overview
+
+This project involves creating a fully functional firing range in Unreal Engine 5 (UE5). You will focus on implementing shooting mechanics, a weapon system, player input handling, physics for projectiles, and basic AI to control moving targets. Your task is to build a simple environment where the player can shoot targets, and all systems should work seamlessly together.
+
+
+
+
+
+### Role Play
+
+You are developing a firing range training level for a first-person shooter game. You are required to set up a working shooting system, integrate a functional weapon with reload mechanics, implement a physics system for projectiles, and design basic AI for moving targets. Additionally, you will create a player HUD that tracks their score, accuracy, and remaining ammunition.
+
+### Learning Objective
+
+By the end of this project, you will have implemented:
+
+- A complete shooting mechanic (with accurate aiming, projectiles, and hit detection).
+- A weapon system with at least one firearm, including shooting and reload mechanics.
+- Basic AI to control target movement.
+- Physics-based projectiles that interact with the environment.
+- A simple UI displaying relevant gameplay information (accuracy, ammo count, etc.).
+- A simple firing range level design that incorporates moving and stationary targets.
### Instructions
-The map of this project should be composed of a cube with dimensions of X = 35, Y = 40, Z = 1. It should simulate the floor and other cubes as walls around the floor. In the map there should be a zone where the character is able to walk around and shoot the targets and another zone where the player can not go and where the targets are present.
+#### General Requirements
+
+- Use `Blueprints` or `C++` to implement the game mechanics.
+- Implement a firing system where the player can aim downsights and shoot.
+- Implement a weapon system that supports shooting, reloading, and proper hit detection.
+- Create a firing range level that includes both stationary and moving targets.
+- Implement a physics system that governs projectile behavior (trajectory and collisions).
+- Implement a HUD that shows the player's score, accuracy, and remaining ammunition.
+
+#### Main Menu
+
+The game's main menu must:
+
+- Be a separate `level/map`.
+- Include the following options:
+ - **Start Game**: Transitions to the firing range gameplay.
+ - **Settings**: Allows the player to adjust mouse sensitivity.
+ - **Quit**: Closes the game.
+
+#### Game Screen (HUD)
+
+The game screen must include a HUD that displays:
+
+- A precise crosshair that accurately indicates the bullet's point of impact.
+- The player's current accuracy (hits devided by total shots fired).
+- Remaining ammunition and reload status for the current weapon.
+
+#### Player Character
+
+The player character must have the following functionalities:
+
+- Basic movement around the firing range.
+- Proper input handling for aiming, shooting, and reloading.
+- Interact with ammo pickups to replenish ammo.
+
+#### Weapons
+
+You must create at least one firearm (e.g., a pistol) that includes:
+
+- Recoil mechanics.
+- Reloading the weapon with an appropriate animation.
+- Projectile physics that simulate bullet trajectories.
+- Bullet hit detection (with an effect on impact, e.g., sound and visual feedback).
+
+#### Targets and AI
+
+You must implement the following for the targets:
+
+- Create a stationary target.
+- Create a moving target with basic AI that follows a predefined path or pattern.
+- Implement hit detection for the targets.
+- Ensure the targets respawn after a set interval once they are hit.
+
+
+ 
+ 
+
+
-For this project you will have to create a Blueprint Class target, that will have some of these characteristics. The target should :
+#### Game Loop Logic
-- have associated to it the previous created material.
-- either be moving from side to side or be stationary.
-- be dynamic, using the timeline node.
-- use a public variable to set or unset the movement animation of the target.
-- rise again after x seconds after being hit it with a projectile, and behave like before it was hit.
+The game loop must be continuous and consist of:
-Only one class of target is allowed for the whole project.
+- The player starts with a loaded weapon and can shoot at targets.
+- The player can open a pause menu at any time, with options to:
+ - Restart the game (reset score, targets, and ammo).
+ - Return to the main menu.
-The previously mentioned projectile should:
+#### Level Design
-- have a size of X = Y = Z = 0,5.
-- have a speed of 10000.
+You must design a firing range that includes:
-After downloading and unzipping this [file](https://assets.01-edu.org/Unreal-Engine-Piscine/FiringRange.zip), you can copy its content to your project Content folder.
+- A coherent theme to ensure a consistent and immersive experience.
+- Proper lighting and environment setup to ensure the range is clear and visually appealing.
+- A section with stationary targets.
+- A section with moving targets.
+- Ammo pickups where the player can restock.
-When finished, your project should look like the executable example on the folder or the ["Expected Result" video](https://youtu.be/EBibaN-dh_0).
+### Bonus
-> Do not forget to zip up the project compile and save everything for peer correction.
-> If it is not possible to upload files to Gitea due to their size, use GitHub instead and have a look at [Git LSF](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)
+- Add multiple weapons (e.g., a shotgun, sniper rifle) with unique shooting and reload mechanics.
+- Implement more advanced target AI, such as random movement patterns or different difficulty levels.
+- Add different hit zones for targets, with headshots awarding more accuracy points.
+- Design a timed challenge mode where the player must hit all targets within a set time frame.
-#### Bonus
+### Submission
-Here are some ideas for improving the game:
+- You must upload a zip file of your game build in your repository.
+ - Ensure that the build works on your platform.
+ - If file size is an issue, use GitHub with [Git LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github).
-- Targets with different speeds.
-- Textures on the walls and ground.
-- Adding obstacles in front of the targets.
+### Resources
-[Here](https://www.youtube.com/playlist?list=PLHyAJ_GrRtf9sxZqgfPVM06PrLk8_CWA-) you can find an instructional playlist on Unreal Engine.
+- [Unreal Engine's AI Documentation](https://dev.epicgames.com/documentation/en-us/unreal-engine/ai-system-settings-in-the-unreal-engine-project-settings?application_version=5.5)
+- [Projectile Movement Component](https://dev.epicgames.com/documentation/en-us/unreal-engine/BlueprintAPI/Game/Components/ProjectileMovement?application_version=5.5)
+- [Mixamo for character animations and models](https://www.mixamo.com/)
+- [SketchFab for 3D models](https://sketchfab.com/)
+- [itch.io for additional assets](https://itch.io/)
diff --git a/subjects/gaming/firing-range/audit/README.md b/subjects/gaming/firing-range/audit/README.md
index 871c9a15c..f3bbd49b7 100644
--- a/subjects/gaming/firing-range/audit/README.md
+++ b/subjects/gaming/firing-range/audit/README.md
@@ -1,27 +1,79 @@
> Due to file size reason, the solution might be uploaded on GitHub instead of Gitea!
-#### Functional
+#### Main menu
-###### Are the map size (X = 35, Y = 40, Z = 1) and composition (using cubes) being respected?
+###### Is the main menu widget on a separate level/map?
-###### Are the projectile size (X = Y = Z = 0,5) and speed (10000) being respected?
+###### Does the main menu contain a Start Game button that transitions to the firing range gameplay?
-###### If you try to move the target to the target zone, is the player forbidden from trespassing to that zone by an invisible wall?
+###### Does the main menu contain a Settings button for adjusting mouse sensitivity?
-###### When you shoot a target, does the bullet go through the invisible wall?
+###### Does the main menu contain an Exit Game button?
-###### Did the targets correctly lay on the floor when hit by the projectile?
+#### HUD
-###### Did the target rotate from the bottom and not from the center?
+###### Does the HUD display an accurate crosshair that indicates the bullet's point of impact?
-###### Is there only one class “BP_Target” present on the project?
+###### Does the HUD display the player's accuracy?
-###### Do all the public variables have a tooltip? (Mouse over it to check if a description is set or check if the variable have a little green eye on the right)
+###### Does the HUD display the remaining ammunition and the reload status?
+
+#### Player Character
+
+###### Can the player character move around the firing range?
+
+###### Is input handling for aiming, shooting, and reloading functional?
+
+###### Can the player interact with ammo pickups to replenish ammunition?
+
+#### Weapons
+
+###### Does the weapon have recoil mechanics implemented?
+
+###### Can the weapon be reloaded and has a proper reloading animation?
+
+###### Are projectile physics implemented for bullets, simulating accurate bullet trajectories?
+
+###### Is hit detection for bullets functional, with audio and visual feedback upon impact?
+
+#### Targets and AI
+
+###### Is there a stationary target present in the firing range?
+
+###### Is there a moving target with basic AI that follows a predefined path or pattern?
+
+###### Is hit detection implemented for both stationary and moving targets?
+
+###### Do the targets respawn after being hit, within a set interval?
+
+#### Level Design
+
+###### Does the firing range follow a coherent and immersive theme?
+
+###### Is the level lighting and environment properly set up for clarity and appeal?
+
+###### Does the level include a section with stationary targets?
+
+###### Does the level include a section with moving targets?
+
+###### Are there ammo pickups available for the player to replenish ammunition?
+
+#### Game Loop Logic
+
+###### Does the game loop start with a loaded weapon, ready for the player to shoot?
+
+###### Can the player open a pause menu?
+
+###### Does the pause menu include a restart button (reset score, targets, and ammo)?
+
+###### Does the pause menu include a return to the main menu button?
#### Bonus
-###### +Do different targets have different speeds?
+###### +Have additional weapons (e.g., shotgun, sniper rifle) with unique shooting and reload mechanics been added?
+
+###### +Has more advanced target AI with random movement patterns or difficulty levels been implemented?
-###### +Do the walls and floor have texture?
+###### +Are there hit zones for targets (e.g., headshots) that award more points or accuracy?
-###### +Are there obstacles in front of targets?
+###### +Has a timed challenge mode been added where the player must hit all targets within a set time frame?
diff --git a/subjects/gaming/firing-range/resources/example1.jpg b/subjects/gaming/firing-range/resources/example1.jpg
new file mode 100755
index 000000000..3f99487ca
Binary files /dev/null and b/subjects/gaming/firing-range/resources/example1.jpg differ
diff --git a/subjects/gaming/firing-range/resources/example2.jpg b/subjects/gaming/firing-range/resources/example2.jpg
new file mode 100755
index 000000000..2285b1666
Binary files /dev/null and b/subjects/gaming/firing-range/resources/example2.jpg differ
diff --git a/subjects/gaming/firing-range/resources/fgm.jpg b/subjects/gaming/firing-range/resources/fgm.jpg
new file mode 100755
index 000000000..c6604989e
Binary files /dev/null and b/subjects/gaming/firing-range/resources/fgm.jpg differ
diff --git a/subjects/its-a-match/README.md b/subjects/its-a-match/README.md
index cc67b3169..61e585c1a 100644
--- a/subjects/its-a-match/README.md
+++ b/subjects/its-a-match/README.md
@@ -2,7 +2,7 @@
### Instructions
-Have you been been pondering over the etymology of `grep`?
+Have you been pondering over the etymology of `grep`?
Create 4 regular expression variables:
diff --git a/subjects/java/checkpoints/distinct-substring-lenght/ExerciseRunner.java b/subjects/java/checkpoints/distinct-substring-length/ExerciseRunner.java
similarity index 100%
rename from subjects/java/checkpoints/distinct-substring-lenght/ExerciseRunner.java
rename to subjects/java/checkpoints/distinct-substring-length/ExerciseRunner.java
diff --git a/subjects/java/checkpoints/distinct-substring-lenght/README.md b/subjects/java/checkpoints/distinct-substring-length/README.md
similarity index 100%
rename from subjects/java/checkpoints/distinct-substring-lenght/README.md
rename to subjects/java/checkpoints/distinct-substring-length/README.md
diff --git a/subjects/quad/audit/README.md b/subjects/quad/audit/README.md
index b60f03e65..22983a916 100644
--- a/subjects/quad/audit/README.md
+++ b/subjects/quad/audit/README.md
@@ -1,6 +1,6 @@
#### quadA
-> ***NOTE: If you are an admin and you want to test this project, follow the instructions [in the this subject](https://github.com/01-edu/go-tests/blob/master/raid-testing.md) before you proceed to the questions.***
+> **_NOTE: If you are an admin and you want to test this project, follow the instructions [in the this subject](https://github.com/01-edu/go-tests/blob/master/raid-testing.md) before you proceed to the questions._**
##### Open the repository of the project and check the submitted files
@@ -14,7 +14,7 @@ o---o
o---o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -22,7 +22,7 @@ o---o
o---o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -30,7 +30,7 @@ o---o
o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -42,19 +42,19 @@ o
o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=20 and y=1"`
@@ -62,7 +62,7 @@ o
o------------------o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=10 and y=8"`
@@ -77,7 +77,7 @@ o--------o
o--------o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadB
@@ -89,7 +89,7 @@ o--------o
\***/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -97,7 +97,7 @@ o--------o
/***\
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -105,7 +105,7 @@ o--------o
/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -117,19 +117,19 @@ o--------o
\
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=18 and y=6"`
@@ -142,7 +142,7 @@ o--------o
\****************/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=9 and y=3"`
@@ -152,7 +152,7 @@ o--------o
\*******/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadC
@@ -164,7 +164,7 @@ B B
CBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -172,7 +172,7 @@ CBBBC
ABBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -180,7 +180,7 @@ ABBBA
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -192,19 +192,19 @@ B
C
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=13 and y=7"`
@@ -218,7 +218,7 @@ B B
CBBBBBBBBBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=10 and y=15"`
@@ -240,7 +240,7 @@ B B
CBBBBBBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadD
@@ -252,7 +252,7 @@ B B
ABBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -260,7 +260,7 @@ ABBBC
ABBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -268,7 +268,7 @@ ABBBC
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -280,19 +280,19 @@ B
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=3 and y=16"`
@@ -315,7 +315,7 @@ B B
ABC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=7 and y=16"`
@@ -338,7 +338,7 @@ B B
ABBBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadE
@@ -350,7 +350,7 @@ B B
CBBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -358,7 +358,7 @@ CBBBA
ABBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -366,7 +366,7 @@ ABBBC
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -378,19 +378,19 @@ B
C
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=21 and y=24"`
@@ -422,7 +422,7 @@ CBBBBBBBBBBBBBBBBBBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=18 and y=8"`
@@ -438,4 +438,4 @@ CBBBBBBBBBBBBBBBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
diff --git a/subjects/user-experience/piscine-ui/atomic-design/README.md b/subjects/user-experience/piscine-ui/atomic-design/README.md
index 5e5a642db..7157c9c51 100644
--- a/subjects/user-experience/piscine-ui/atomic-design/README.md
+++ b/subjects/user-experience/piscine-ui/atomic-design/README.md
@@ -1,4 +1,4 @@
-## Browsing
+### Browsing
**Context:**
@@ -48,7 +48,7 @@ Don't forget to:
- User Interface Design is a hybrid role and can bring together concepts from interaction design, visual design, information architecture and even Front End Development.
-## Material Design
+### Material Design
### Instructions
@@ -74,7 +74,7 @@ Don't forget to:
- [Material Design Awards 2019](https://design.google/library/material-design-awards-2019/)
- [What is Material Design - Wikipedia](https://en.wikipedia.org/wiki/Material_Design)
-## Design system library
+### Design system library
### Instructions
@@ -103,7 +103,7 @@ Don't forget to:
- [Atomic Design Methodology](https://atomicdesign.bradfrost.com/chapter-2/)
-## Library for climbing addicts
+### Library for climbing addicts
### Instructions
@@ -145,7 +145,7 @@ Don't forget to:
- [Building a design system library - Lyft](https://medium.com/tap-to-dismiss/building-a-design-system-library-532ef2492811)
- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
-## Library for a dating app
+### Library for a dating app
### Instructions
@@ -185,4 +185,4 @@ Don't forget to:
- [Introduction to design systems](https://www.youtube.com/watch?v=xEuBCUngJ_U)
- [Create a design system - Figma course](https://www.youtube.com/watch?v=RYDiDpW2VkM)
- [Building a design system library - Lyft](https://medium.com/tap-to-dismiss/building-a-design-system-library-532ef2492811)
-- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
\ No newline at end of file
+- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
diff --git a/subjects/user-experience/piscine-ui/building-an-interface/README.md b/subjects/user-experience/piscine-ui/building-an-interface/README.md
index ca292bf0e..cb0d6aedd 100644
--- a/subjects/user-experience/piscine-ui/building-an-interface/README.md
+++ b/subjects/user-experience/piscine-ui/building-an-interface/README.md
@@ -1,4 +1,4 @@
-## Styleguide
+### Styleguide
**Context:**
@@ -47,7 +47,7 @@ Don't forget to:
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
- [Example of a Style Guide in UI](https://www.pinterest.pt/pin/454019206175050454/)
-## Design system library
+### Design system library
### Instructions
@@ -82,7 +82,7 @@ Don't forget to:
- [Building a design system library - Lyft](https://medium.com/tap-to-dismiss/building-a-design-system-library-532ef2492811)
- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
-## Design screens
+### Design screens
### Instructions
@@ -115,7 +115,7 @@ Don't forget to:
- [Unsplash](https://unsplash.com/) for visuals
-## Animation
+### Animation
### Instructions
@@ -141,9 +141,10 @@ Don't forget to:
**Quote:**
"Speak human: Use the words your users use.’ Dan Saffer | Microinteractions.
+
- [From low-fidelity to high-fidelity](https://mockitt.wondershare.com/prototyping/low-fidelity-vs-high-fidelity.html)
-## Desirability testing
+### Desirability testing
### Instructions
@@ -181,4 +182,4 @@ Don't forget to:
**Quote:**
-- "Interaction design focuses on the design of behavior of a person’s interaction with a digital interface. It is also concerned with satisfying the needs and desires of the people who will interact with a product or service.’ Alan Cooper, About Face: The Essentials of Interaction Design
\ No newline at end of file
+- "Interaction design focuses on the design of behavior of a person’s interaction with a digital interface. It is also concerned with satisfying the needs and desires of the people who will interact with a product or service.’ Alan Cooper, About Face: The Essentials of Interaction Design
diff --git a/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md b/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md
index 9fdd95f39..2e69635c7 100644
--- a/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md
+++ b/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md
@@ -1,4 +1,4 @@
-## Find the colors
+### Find the colors
**Context:**
@@ -38,7 +38,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## Color codes
+### Color codes
### Instructions
@@ -72,7 +72,7 @@ Don't forget to :
- [https://brave.com/es/](https://brave.com/es/)
- [https://www.ted.com/](https://www.ted.com/)
-## Color combinations
+### Color combinations
### Instructions
@@ -151,7 +151,7 @@ Don't forget to:
- [https://calendar.google.com/](https://calendar.google.com/)
- [https://www.ebay.com/](https://www.ebay.com/)
-## Moodboard
+### Moodboard
### Instructions
@@ -185,7 +185,7 @@ Don't forget to:
- [Example3](https://i.pinimg.com/564x/ee/9d/d6/ee9dd6fbb82b0e5b4dd2924580b765dd.jpg)
- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Typography
+### Typography
### Instructions
@@ -226,7 +226,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## Typography moodboard
+### Typography moodboard
### Instructions
@@ -268,7 +268,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## UI Challenge - Timer
+### UI Challenge - Timer
### Instructions
@@ -298,7 +298,7 @@ Don't forget to:
- The frame is Android 360 x 640px.
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Watches
+### UI Challenge - Watches
### Instructions
@@ -332,7 +332,7 @@ Don't forget to:
- You can use existing Libraries by browsing the Figma community resources.
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Flight
+### UI Challenge - Flight
### Instructions
@@ -362,7 +362,7 @@ Don't forget to:
- [Figma article about Symbols and Variants](https://help.figma.com/hc/en-us/articles/360056440594-Create-and-use-variants).
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Spotify
+### UI Challenge - Spotify
### Instructions
@@ -394,7 +394,7 @@ Don't forget to:
- [Figma article about Symbols and Variants](https://help.figma.com/hc/en-us/articles/360056440594-Create-and-use-variants).
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Bitcoin Dashboard
+### UI Challenge - Bitcoin Dashboard
### Instructions
diff --git a/subjects/user-experience/piscine-ui/heuristics/README.md b/subjects/user-experience/piscine-ui/heuristics/README.md
index a6f2688da..64cc5f5ba 100644
--- a/subjects/user-experience/piscine-ui/heuristics/README.md
+++ b/subjects/user-experience/piscine-ui/heuristics/README.md
@@ -1,4 +1,4 @@
-## Audit
+### Audit
**Context:**
@@ -49,7 +49,7 @@ Don't forget to:
- [A new usability heuristic evaluation checklist](https://uxplanet.org/a-new-usability-heuristic-evaluation-checklist-259f588da308)
- [Tool : Heuristic evaluation checklist](https://drive.google.com/file/d/10KbfbNZA1oVS1sXbjjXLPPmdZ6nqVkdc/view)
-## Recommendations
+### Recommendations
### Instructions
diff --git a/subjects/user-experience/piscine-ui/rules/README.md b/subjects/user-experience/piscine-ui/rules/README.md
index dc05ffa8c..7556c1559 100644
--- a/subjects/user-experience/piscine-ui/rules/README.md
+++ b/subjects/user-experience/piscine-ui/rules/README.md
@@ -1,4 +1,4 @@
-## Grids
+### Grids
**Context:**
@@ -37,7 +37,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## Multi state
+### Multi state
### Instructions
@@ -67,7 +67,7 @@ Don't forget to:
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
- [Example here with Nintendo.com](https://www.figma.com/file/ahSnWRZeKBO62oJDiXltxY/UI-III---Ex-2) (The screenshots date back to nov 2021. They may differ from the current version of [Nintendo.com](http://Nintendo.com) but the rules are the same).
-## Accessibility (website)
+### Accessibility (website)
### Instructions
@@ -106,7 +106,7 @@ Don't forget to:
- Error states.
- etc.
-## Accessibility (app)
+### Accessibility (app)
### Instructions
@@ -144,7 +144,7 @@ Don't forget to:
- Error states
- etc.
-## Breadcrumbs
+### Breadcrumbs
### Instructions
@@ -167,7 +167,7 @@ Don't forget to:
- [What are breadcrumbs?](https://www.seoptimer.com/blog/breadcrumbs-website/)
-## Toggle buttons
+### Toggle buttons
### Instructions
@@ -190,7 +190,7 @@ Don't forget to:
- [Toggle Switch - Tips](https://uxplanet.org/toggle-switch-5-simple-design-tips-for-better-design-b4046eff4a2f)
-## Radio buttons
+### Radio buttons
### Instructions
@@ -213,7 +213,7 @@ Don't forget to:
- [What is a radio button?](https://www.justinmind.com/blog/radio-button-design-examples/)
-## Calendars
+### Calendars
### Instructions
@@ -232,7 +232,7 @@ Don't forget to:
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Time pickers
+### Time pickers
### Instructions
@@ -251,7 +251,7 @@ Don't forget to:
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Micro-interactions
+### Micro-interactions
### Instructions
@@ -282,7 +282,7 @@ Don't forget to:
- [Why use micro-interactions in your design](https://hike.one/update/why-use-micro-animations-in-your-design)
- [Micro-interactions: why, when, and how to use them to boost the UX](https://uxdesign.cc/micro-interactions-why-when-and-how-to-use-them-to-boost-the-ux-17094b3baaa0)
-## Consistency
+### Consistency
### Instructions
diff --git a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md
index 6f399c023..4384e64b6 100644
--- a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md
+++ b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md
@@ -1,4 +1,4 @@
-## User Interviews
+### User Interviews
**Context:**
@@ -86,7 +86,7 @@ Thank you so much for your time!
I have a last favor to ask you: is there anyone you know who runs frequently and would be available for a talk?
-## Analytics
+### Analytics
### Instructions
@@ -125,7 +125,7 @@ Examples of insights you can extract from the articles:
Always base your decisions on the data, not on your biases.
-## Personas
+### Personas
### Instructions
@@ -165,7 +165,7 @@ Use the material you got from the exercise `User interview` to build the pierre
"Focus unswervingly, on the customer’ Jesse Hertzberg | Former COO of Squarespace
-## User Journey
+### User Journey
### Instructions
@@ -209,7 +209,7 @@ Most articles you'll find will be about user journeys or customer journeys. Keep
'It’s about catching customers in the act, and providing highly relevant and highly contextual information’ Paul Maritz | CEO Pivotal
-## Problem Statement
+### Problem Statement
### Instructions
@@ -257,7 +257,7 @@ Based on the insights from the exercises `analytics` and `user interviews`, comm
“If I had an hour to solve a problem, I’d spend 55 minutes thinking about the problem and 5 minutes thinking about solutions.” Albert Einstein
-## Ideation
+### Ideation
_You can replace Pierre with your own persona._
@@ -330,7 +330,7 @@ Don't forget to:
Chances are that... If you have gone through all possible solutions, you’ve found the good one.
-## Prototyping
+### Prototyping
### Instructions
diff --git a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md
index 19ec07314..a4e64eee6 100644
--- a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md
+++ b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md
@@ -1,4 +1,4 @@
-### User interview
+#### User interview
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -12,7 +12,7 @@
###### Does each insight have the name of the person(s) who said it?
-### Analytics
+#### Analytics
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -28,7 +28,7 @@
###### Are the insights different from the ones given in the instructions as an example?
-### Personas
+#### Personas
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -54,7 +54,7 @@
###### Are the insights from ex 1 included in Pierre's persona card?
-### User Journey
+#### User Journey
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -76,7 +76,7 @@
###### For every thought, is there a main emotion?
-### Problem Statement
+#### Problem Statement
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -92,7 +92,7 @@
##### Is the problem statement broad enough (check the readme tips to understand broad)?
-### Ideation
+#### Ideation
###### Is there a zip folder?
@@ -108,7 +108,7 @@
###### Is there one main idea to solve the problem?
-### Prototyping
+#### Prototyping
###### Is there a zip folder?
diff --git a/subjects/user-experience/piscine-ux/going-on-holidays/README.md b/subjects/user-experience/piscine-ux/going-on-holidays/README.md
index 2cf3787dd..4d7357128 100644
--- a/subjects/user-experience/piscine-ux/going-on-holidays/README.md
+++ b/subjects/user-experience/piscine-ux/going-on-holidays/README.md
@@ -1,4 +1,4 @@
-## Interview guide
+### Interview guide
**Context:**
@@ -46,7 +46,7 @@ Here are the recommended steps :
“To ask open-ended questions is the best approach, but it’s easy to get into the weeds in data analysis when every answer is a paragraph or two of prose. Users quickly tire of answering many open-ended questions, which usually require a lot of typing and explanation.” Norman Nielsen Group
-## Run interviews
+### Run interviews
### Instructions
@@ -68,7 +68,7 @@ Then, write down the script on a written document, and give elements of context
- Pay attention to the global aspect of the document. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Affinity diagram & Empathy map
+### Affinity diagram & Empathy map
### Instructions
@@ -108,7 +108,7 @@ Don't forget to:
Remember, you are not the user, so your opinions are not absolute truth.
-## Problem statement
+### Problem statement
### Instructions
@@ -137,7 +137,7 @@ You may use the "How Might We" exercise in pairs.
"Out of clutter, find simplicity. From discord, find harmony. In the middle of difficulty, lies opportunity.’ Albert Einstein
-## Ideation
+### Ideation
### Instructions
@@ -180,7 +180,7 @@ Quote:
- "Brainstorming means using the brain to storm a creative problem. Do so in commando fashion, with each stormer attacking the same objective.’ Alex Faickney Osborn
-## User flow
+### User flow
### Instructions
@@ -210,7 +210,7 @@ Don't forget to:
"Each use case is represented as a sequence of simple steps, beginning with a user’s goal and ending when that goal is fulfilled.’ Usability.gov
-## Prototyping
+### Prototyping
### Instructions
@@ -243,4 +243,4 @@ Give another dimension to your user flow and turn it into a paper prototype (6 t
**Quote:**
-Any design is like a joke …if you have to explain it, it’s bad.
\ No newline at end of file
+Any design is like a joke …if you have to explain it, it’s bad.
diff --git a/subjects/user-experience/piscine-ux/music-on/README.md b/subjects/user-experience/piscine-ux/music-on/README.md
index 73da0a5e6..c249421d7 100644
--- a/subjects/user-experience/piscine-ux/music-on/README.md
+++ b/subjects/user-experience/piscine-ux/music-on/README.md
@@ -1,4 +1,4 @@
-## Heuristics
+### Heuristics
**Context:**
@@ -41,7 +41,7 @@ Conduct a heuristic analysis on **one** of these websites:
'If you think design is expensive, you should look at the cost of bad design’ Ralf Speth | Former CEO Jaguar Land Rover
-## Site map
+### Site map
### Instructions
@@ -81,7 +81,7 @@ Stick to the website you have chosen in the previous exercise "heuristics" and d
"The organization, search, and navigation systems that help people to complete tasks, find what they need, and understand what they’ve found’ Peter Morville | Information Architecture for the WWW.
-## JTBD
+### JTBD
### Instructions
@@ -121,7 +121,7 @@ And remember: You are not your user!
- "Documenting the what and why of each element promotes organization and makes the handoff to the development team much smoother." UX Booth
- "When we buy a product, we essentially "hire" something to get a job done. If it does the job well, when we are confronted with the same job, we hire that same product again. And if the product does a crummy job, we "fire" it and look around for something else we might hire to solve the problem." Clayton M Christensen
-## Card sorting
+### Card sorting
### Instructions
@@ -168,7 +168,7 @@ Don't forget to:
- [10 things to know about card sorting](http://www.measuringu.com/blog/card-sorting.php)
- [Card sorting: a definitive guide](http://boxesandarrows.com/card-sorting-a-definitive-guide/)
-## Music label wireframes
+### Music label wireframes
### Instructions
@@ -218,7 +218,7 @@ Vocabulary:
- Figma.
-## Test protocol
+### Test protocol
### Instructions
@@ -257,7 +257,7 @@ Don't forget to:
- You need to detect: How many errors do users make? How severe are these errors? How easily can they recover from the errors?
-## Run 5 tests
+### Run 5 tests
### Instructions
@@ -287,4 +287,4 @@ Don't forget to:
**Quote:**
-- To get trustworthy results in your test, you can’t ask your customers to use their imagination. You’ve got to show them something realistic. If you do, their reactions will be genuine.
\ No newline at end of file
+- To get trustworthy results in your test, you can’t ask your customers to use their imagination. You’ve got to show them something realistic. If you do, their reactions will be genuine.
diff --git a/subjects/user-experience/piscine-ux/seamstress/README.md b/subjects/user-experience/piscine-ux/seamstress/README.md
index 7ce1d6c39..dbd60f794 100644
--- a/subjects/user-experience/piscine-ux/seamstress/README.md
+++ b/subjects/user-experience/piscine-ux/seamstress/README.md
@@ -1,4 +1,4 @@
-## UX strategy
+### UX strategy
**Context:**
@@ -49,7 +49,7 @@ Don't forget to:
- Design needs to fail. Failure is even a necessary step, but ideally it should happen before a product is launched, during the prototype and test phases
- “UX Strategy lies at the intersection of UX and business. It provides a much better chance of creating successful products. It enables teams to see the “Big Picture” to achieve the business goals under uncertain conditions” Jamie Levy | UX Strategy: How to Devise Innovative Digital Products That People Want
-- UX Strategy is the method by which you validate that your solution solves a problem for real customers in a dynamic marketplace because the market is constantly changing.
+- UX Strategy is the method by which you validate that your solution solves a problem for real customers in a dynamic marketplace because the market i#s constantly changing.
## Empathy
@@ -111,7 +111,7 @@ Don't forget to:
- With 5 to 10 criteria
- 10 organizations appear on the table
-## Define
+### Define
### Instructions
@@ -158,7 +158,7 @@ Don't forget to:
- The "I want to" part involves a practical action.
- The "So I can" part involves a psychological or emotional purpose.
-## Problem statement
+### Problem statement
### Instructions
@@ -199,7 +199,7 @@ Design is about solving problems. Fall in Love with the Problem, Not the Solutio
- How might make sure Pierre doesn’t get drunk the night before the race?
- Out of scope —> This is not about dehydration, nor about running.
-## Ideation
+### Ideation
### Instructions
@@ -221,7 +221,7 @@ Don't forget to:
- Use as many tools as needed, and make sure you do all the process in 4 working days!
- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Prototype
+### Prototype
### Instructions
@@ -265,7 +265,7 @@ Don't forget to:
- High-Fidelity: Wireframes with color, styles, graphical details, and micro-interactions - [Example here](https://miro.medium.com/max/1400/1*Xn0HSKAvhr4TZzC9lN5udw.gif)
- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Test protocol
+### Test protocol
### Instructions
@@ -295,4 +295,4 @@ Don't forget to:
**Tips:**
-- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
\ No newline at end of file
+- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
diff --git a/subjects/user-experience/piscine-ux/sunday-night-movie/README.md b/subjects/user-experience/piscine-ux/sunday-night-movie/README.md
index f85540f21..1612a41e2 100644
--- a/subjects/user-experience/piscine-ux/sunday-night-movie/README.md
+++ b/subjects/user-experience/piscine-ux/sunday-night-movie/README.md
@@ -1,4 +1,4 @@
-## User flow
+### User flow
**Context:**
@@ -39,7 +39,7 @@ Don't forget to:
**Recommended tools:**
- Figma.
-- Whimsical.
+- Whimsical.#
## Movie wireframes
@@ -79,7 +79,7 @@ Don't forget to:
- "77% of users return to content and information sites because of ease-of-use. Only 22% return because the site belongs to a favorite brand." Forrester
-## Wireframes animation
+### Wireframes animation
### Instructions
@@ -106,7 +106,7 @@ Don't forget to:
- [Efficiently Manage Your Designs - How Mockplus State Page Helps To View & Manage Multiple State](https://help.mockplus.com/p/372)
-## Test on features
+### Test on features
### Instructions
@@ -140,7 +140,7 @@ Don't forget to:
- [The art of guerrilla usability testing](http://www.uxbooth.com/articles/the-art-of-guerrilla-usability-testing/)
- [How to write a user testing report that people will actually read](https://uxdesign.cc/how-to-write-a-user-testing-report-that-people-will-actually-read-652d15d2f92e)
-## Iteration
+### Iteration
### Instructions
@@ -166,4 +166,4 @@ Don't forget to:
**Tips:**
- This report will be handed on to the CEO. Pay attention to the details and make sure the document is clean and easy to use!
-- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
\ No newline at end of file
+- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
diff --git a/subjects/user-experience/piscine-ux/teenage-drama/README.md b/subjects/user-experience/piscine-ux/teenage-drama/README.md
index 8f2ddf161..ca199954d 100644
--- a/subjects/user-experience/piscine-ux/teenage-drama/README.md
+++ b/subjects/user-experience/piscine-ux/teenage-drama/README.md
@@ -1,4 +1,4 @@
-## Competitive Analysis
+### Competitive Analysis
**Context:**
@@ -43,7 +43,7 @@ Don't forget to:
**Quote:**
- 'Always design a thing in its larger context: a chair in a room, a room in a house, a house in an environment, an environment in a city plan’ Eero Sarrinen | Knoll
-- Creating a great design isn’t just about understanding what the user wants. It’s also about understanding and delivering on what the business needs.
+- Creating a great design isn’t just about understanding what the user wants. It’s also about understanding and delivering on what the business needs.#
## Surveys
@@ -99,7 +99,7 @@ Here are the recommended steps:
- “Surveys measure and categorize attitudes or collect self-reported data that can help track or discover important issues to address.” Norman Nielsen Group
- Surveys are not accurate in providing behavioral data because USERS OMIT STEPS IN THE MIDDLE AND MEMORIES ARE FAULTY.
-## Broadcast strategy
+### Broadcast strategy
### Instructions
@@ -141,7 +141,7 @@ Once your strategy is prepared, run it!
- [How to get more survey responses](https://rafflepress.com/how-to-get-more-survey-responses/)
-## Interviews
+### Interviews
### Instructions
@@ -183,7 +183,7 @@ Here are the recommended steps :
- [How to design better products through user interviews](https://uxdesign.cc/how-to-design-better-products-through-user-interviews-4c5142bb1fc4)
- [Asking the right questions](https://uxdesign.cc/asking-the-right-questions-on-user-research-interviews-and-testing-427261742a67)
-## Personas
+### Personas
### Instructions
@@ -215,7 +215,7 @@ Your persona card should include common trends amongst the people you got data f
- "If you design for everyone, you delight no one."
- "A good user persona is the one based on user research, without regard to how many attributes we can describe."
-## User journey
+### User journey
### Instructions
@@ -254,7 +254,7 @@ Most articles you'll find will be about user journeys or customer journeys. Keep
- “More options = More problems.” Scott Belsky | VP of Product & Community Adobe
- "A customer journey map is a visualization of the process that a person goes through in order to accomplish a goal. It’s used for understanding and addressing customer needs and pain points’ Norman Nielsen Group
-## Problem statement
+### Problem statement
### Instructions
diff --git a/subjects/user-experience/piscine-ux/the-olympics/README.md b/subjects/user-experience/piscine-ux/the-olympics/README.md
index 79e366d1b..1caa19e10 100644
--- a/subjects/user-experience/piscine-ux/the-olympics/README.md
+++ b/subjects/user-experience/piscine-ux/the-olympics/README.md
@@ -1,4 +1,4 @@
-## Ideation A
+### Ideation A
**Context:**
@@ -51,7 +51,7 @@ Don't forget to:
- [3 proven methods to organize a brainstorming session](https://uxdesign.cc/brainstorm-79e51f20f313)
- [Effective brainstorming (without feeling lost)](https://uxdesign.cc/effective-brainstorming-without-being-lost-b68750bbfac5?sk=5d5a332f7e3f2a43364c031b01b13229)
- [The myth of brainstorming](https://uxdesign.cc/the-myth-of-brainstorming-8517e02facc0?sk=995d601cbf988d574e86dd71364cb92f)
-- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to-use-the-best-ideation-methods-worst-possible-idea)
+- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to#-use-the-best-ideation-methods-worst-possible-idea)
## Ideation B
@@ -102,7 +102,7 @@ Pay attention not to use the same ideation technique as in Ex 1!
- [The myth of brainstorming](https://uxdesign.cc/the-myth-of-brainstorming-8517e02facc0?sk=995d601cbf988d574e86dd71364cb92f)
- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to-use-the-best-ideation-methods-worst-possible-idea)
-## Ideation C
+### Ideation C
### Instructions
@@ -151,7 +151,7 @@ Pay attention not to use the same ideation technique as in Ex 2!
- [The myth of brainstorming](https://uxdesign.cc/the-myth-of-brainstorming-8517e02facc0?sk=995d601cbf988d574e86dd71364cb92f)
- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to-use-the-best-ideation-methods-worst-possible-idea)
-## User flow
+### User flow
### Instructions
@@ -178,7 +178,7 @@ Don't forget to:
- [Site flows vs User Flows](https://uxmovement.com/wireframes/site-flows-vs-user-flows-when-to-use-which/)
- [How to make a User Flow diagram](https://www.lucidchart.com/blog/how-to-make-a-user-flow-diagram)
-## Prototyping
+### Prototyping
### Instructions
@@ -219,7 +219,7 @@ Don't forget to:
- "To prototype your solution, you’ll need a temporary change of philosophy: from perfect to just enough, from long-term quality to temporary simulation."
- "The prototype is meant to answer questions, so keep it focused. You just need a real-looking facade to which customers can react."
-## Animation
+### Animation
### Instructions
@@ -244,7 +244,7 @@ This exercise is to be made individually.
- [Efficiently Manage Your Designs - How Mockplus State Page Helps To View & Manage Multiple State](https://help.mockplus.com/p/372)
-## Test wireframe
+### Test wireframe
### Instructions
@@ -280,4 +280,4 @@ Don't forget to:
**Quote:**
-Prototypes are created for testing purposes, that’s why creating a prototype without running tests on it makes no sense.
\ No newline at end of file
+Prototypes are created for testing purposes, that’s why creating a prototype without running tests on it makes no sense.
diff --git a/subjects/user-experience/projects/a-table/audit/README.md b/subjects/user-experience/projects/a-table/audit/README.md
index e135adf6f..91b03aca4 100644
--- a/subjects/user-experience/projects/a-table/audit/README.md
+++ b/subjects/user-experience/projects/a-table/audit/README.md
@@ -1,6 +1,6 @@
#### A table
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
diff --git a/subjects/user-experience/projects/get-a-room/audit/README.md b/subjects/user-experience/projects/get-a-room/audit/README.md
index 4e29cbb7a..85beb00c5 100644
--- a/subjects/user-experience/projects/get-a-room/audit/README.md
+++ b/subjects/user-experience/projects/get-a-room/audit/README.md
@@ -1,6 +1,6 @@
#### Get a room
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
diff --git a/subjects/user-experience/projects/lets-do-some-sports/audit/README.md b/subjects/user-experience/projects/lets-do-some-sports/audit/README.md
index 680df33d7..fd09c4ae1 100644
--- a/subjects/user-experience/projects/lets-do-some-sports/audit/README.md
+++ b/subjects/user-experience/projects/lets-do-some-sports/audit/README.md
@@ -1,6 +1,6 @@
#### Let's do some sports
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
diff --git a/subjects/user-experience/projects/lets-fair-trade/README.md b/subjects/user-experience/projects/lets-fair-trade/README.md
index e229a223d..043c7e190 100644
--- a/subjects/user-experience/projects/lets-fair-trade/README.md
+++ b/subjects/user-experience/projects/lets-fair-trade/README.md
@@ -4,7 +4,7 @@ Creation of an ecommerce platform for second-hand clothes on desktop and mobile
Bruno loves fashion. He loves buying clothes! As he is cautious with the environment, he prefers buying second-hand clothing. However, the existing platforms are not very user-friendly.
-"I need to know more about the environmental impact of the pieces I buy. I’d like to know how old they are, where they are coming from, to measure their life and the amount of kilometres they have traveled. When a new pair of jeans arrive at the ready-to-wear store in Europe, they consumed approximately 11,000 litres of water and travelled 65,000 kilometres. I’d like to monitor that kind of data.’
+"I need to know more about the environmental impact of the pieces I buy. I’d like to know how old they are, where they are coming from, to measure their life and the amount of kilometers they have traveled. When a new pair of jeans arrive at the ready-to-wear store in Europe, they consumed approximately 11,000 litres of water and traveled 65,000 kilometers. I’d like to monitor that kind of data.’
You gather a team of 3 to think and design a website and an app for second-hand products.
diff --git a/subjects/user-experience/projects/lets-fair-trade/audit/README.md b/subjects/user-experience/projects/lets-fair-trade/audit/README.md
index 211d80533..1aa8e8b32 100644
--- a/subjects/user-experience/projects/lets-fair-trade/audit/README.md
+++ b/subjects/user-experience/projects/lets-fair-trade/audit/README.md
@@ -1,6 +1,6 @@
#### Let's fair trade!
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
` section !
```HTML
@@ -77,7 +77,7 @@ Inside your HTML file, set up the basic structure of the HTML document with a `<
#### 3- Put your robots inside the gallery:
-- Under the `title` div, create a div element with the `id` `gallery`.
+- Under the `title` div, create a div element with the `id` **gallery**.
- This div will serve as the container for all the robot portraits.
@@ -209,7 +209,7 @@ h3 {
> Trust the process!
-- Then add this gallery style block, and change the `background-color` of it based on your team's favorite color:
+- Then add this gallery style block, and change its `background-color` based on your team's favorite color:
```css
#gallery {
@@ -223,17 +223,17 @@ h3 {
}
```
-- Add the following block of style to all your class's of `name-robot`. To do so, we follow the rule:
+- Add the following style block to all your `name-robot` classes. To do so, we follow the rule:
```css
.class-one,
.class-two,
.class-three {
- /* block of style */
+ /* style block */
}
```
-- Name it with your `name-robot` for each member of the team, and put inside the block the following styles:
+- Name it with the `name-robot` of each teammember, and add inside the block the following styles:
```css
{
@@ -266,9 +266,9 @@ h3 {
> Experiment by changing the colors of the box-shadow and the scale value! Be creative.
-- In your `#gallery` CSS rule, add some animated gradient color to the background! You can achieve it by combining CSS properties: `background`, `background-size`, `animation`, `box-shadow`.
+- In your `#gallery` CSS rule, add some animated gradient color to the background! You can achieve it by combining CSS properties: `background`, `background-size`, `animation` and `box-shadow`.
-> Hint : Do not forget to replace the background property with the new value bellow!
+> Hint : Do not forget to replace the background property with the new value below!
_For Example:_
@@ -284,9 +284,9 @@ animation: gradientBackground 2s ease infinite; /* Animates the background to cr
box-shadow: 0 5px 15px rgba(0, 0, 0, 0.2); /* Adds a shadow around the element. Adjust the offsets, blur radius, and opacity as needed */
```
-> You saw no change? well we did not specify yet what to do with all those colors, angles and timing yet!
+> You didn't see any change? Well we didn't specify what to do with all those colors, angles and timing yet!
-- Let's make it more exciting, by actually making the colors move! We can do that with `keyframes`! Under the `#gallery` css rule, put the `keyframes`` block and see the magic !
+- Let's make it more exciting by actually making the colors move! We can do that with `keyframes`! Under the `#gallery` css rule, put the `keyframes` block and see the magic !
_For Example:_
@@ -310,7 +310,7 @@ _For Example:_
- "How do I create a smooth gradient background with multiple colors in CSS?"
-- "Explain to me as a beginner these CSS properties: `background`, `background-size`, `animation`, `box-shadow`."
+- "Explain to me as a beginner these CSS properties: `background`, `background-size`, `animation` and `box-shadow`."
### Task 3: Add Interactivity with JavaScript:
@@ -324,15 +324,15 @@ Follow the following steps:
- Create a function named `changeArmColor`.
- This function should accept a parameter `robotClass` to identify which robot to modify.
- - Inside the function, generate a random color using JavaScript, to both `left` and `right` arms.
+ - Inside the function, generate a random color using JavaScript, to apply to both `left` and `right` arms.
```js
const randomColor = `#${Math.floor(Math.random() * 16777215).toString(16)}`;
```
- Use `document.querySelector` to select the `left` and `right` arm elements of the robot.
- - Apply the random color to both arm elements using `style.backgroundColor`.
- - Here is an example, do the same for right arm:
+ - Apply the random color to both arm' elements using `style.backgroundColor`.
+ - Below is an example, do the same for the right arm:
```js
const randomColor = `#${Math.floor(Math.random() * 16777215).toString(16)}`;
@@ -340,30 +340,30 @@ Follow the following steps:
document.querySelector(`.${robotClass} #arm-left`).style.backgroundColor =
randomColor;
- //do the same to right arm
+ //do the same to the right arm
```
- **Function to Change Legs Colors**:
- Create a function named `changeLegColor`.
- - Follow the same steps as the `changeArmColor` function but target the `legs`.
+ - Follow the same steps as the `changeArmColor` function but have it target the `legs`.
- **Function to Change Eye Colors**:
- Create a function named `changeEyeColor`.
- - Follow the same steps as the `changeArmColor` function but target the `eye`.
+ - Follow the same steps as the `changeArmColor` function but have it target the `eye`.
- **Function to Change Face Colors**:
- Create a function named `changeFaceColor`.
- - Follow the same steps as the `changeArmColor` function but target the `eyes` `id`. (Yes, pay attention, the `id` that changes the face color is called `eyes`!)
+ - Follow the same steps as the `changeArmColor` function but target the `eyes` **id**. (Yes, pay attention, the `id` that changes the face color is called `eyes`!)
#### 3- Adding Event Listeners for Keyboard Input:
Next, you need to detect when specific keys are pressed and trigger the corresponding function.
- Use `document.addEventListener` to listen for `keydown` events.
-- Inside the event listener, use multiple `if` statements to check which `key` was `pressed`.
+- Inside the event listener, use multiple `if` statements to check which `key` is `pressed`.
- Depending on the `key` pressed, call the appropriate `function` and pass the `robot's class` as an `argument`.
_Code example:_
@@ -389,7 +389,7 @@ document.addEventListener("keydown", function (event) {
});
```
-- You should decide with your team mates the keys that will trigger each robot of yours!
+- You should decide with your teammates the keys that will trigger each of your robots!
**`Prompt Example:`**
@@ -400,13 +400,13 @@ document.addEventListener("keydown", function (event) {
- Ensure that all robots are displayed correctly in the gallery.
-- Make sure all files (robots-harmony.html, robots-harmony.css, robots-harmony.js) are in the same folder submitted to your `Gitea`.
+- Make sure all files (robots-harmony.html, robots-harmony.css, robots-harmony.js) are in the same folder submitted in the repository of your `Gitea` account.
- Double-check the code to ensure everything is clean and well-organized.
### Expected Output
-Your project needs to check all the previous tasks, it will look something close to (and maybe better than) [this](https://youtu.be/pWD0tbyTyiI).
+Your project needs to check all the previous tasks, it will look something close to (and maybe better than) [this](https://youtu.be/drQsUzPeoAQ).
### Bonus part
diff --git a/subjects/DPxAI/robots-harmony/audit/README.md b/subjects/AI.GO/robots-harmony/audit/README.md
similarity index 100%
rename from subjects/DPxAI/robots-harmony/audit/README.md
rename to subjects/AI.GO/robots-harmony/audit/README.md
diff --git a/subjects/DPxAI/select-then-style/README.md b/subjects/AI.GO/select-then-style/README.md
similarity index 95%
rename from subjects/DPxAI/select-then-style/README.md
rename to subjects/AI.GO/select-then-style/README.md
index 346d7313e..d7c8db2dd 100644
--- a/subjects/DPxAI/select-then-style/README.md
+++ b/subjects/AI.GO/select-then-style/README.md
@@ -32,7 +32,7 @@ Now that you have created and properly identified the different sections of your
- `width` of `100%`
- `height` of `calc(100% / 3)` _(one third of the `body` height)_
-- Target each of the following elements with the [`id` selector][4], using the `id` you defined earlier for each section, and style them:
+- Target each of the following elements with the [id selector][4], using the `id` you defined earlier for each section, and style them:
- `face` with a "cyan" `background-color`
- `upper-body` with a "blueviolet" `background-color`
- `lower-body` with a "lightsalmon" `background-color`
diff --git a/subjects/DPxAI/star-forge/README.md b/subjects/AI.GO/star-forge/README.md
similarity index 100%
rename from subjects/DPxAI/star-forge/README.md
rename to subjects/AI.GO/star-forge/README.md
diff --git a/subjects/DPxAI/the-skeleton/README.md b/subjects/AI.GO/the-skeleton/README.md
similarity index 93%
rename from subjects/DPxAI/the-skeleton/README.md
rename to subjects/AI.GO/the-skeleton/README.md
index 3ec477379..47dcfa1c1 100644
--- a/subjects/DPxAI/the-skeleton/README.md
+++ b/subjects/AI.GO/the-skeleton/README.md
@@ -24,7 +24,7 @@ We provide you with some content to get started smoothly, check it out!
- Video [Basic set up of an HTML page](https://www.youtube.com/watch?v=QtKoO7tT-Gg&list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF&index=1)
- Video [Different HTML tags overview](https://www.youtube.com/watch?v=Al-Jzpib8VY&list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF&index=2)
-Those videos are accompanying you step by step in each exercise, but if you want to check right away all the notions covered in the quest, you can watch the whole playlist throughout your next exercices[Web - HTML, CSS & DOM JavaScript](https://www.youtube.com/playlist?list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF).
+Those videos are accompanying you step by step in each exercise, but if you want to check right away all the notions covered in the quest, you can watch the whole playlist throughout your next exercises[Web - HTML, CSS & DOM JavaScript](https://www.youtube.com/playlist?list=PLHyAJ_GrRtf979iZZ1N3qYMfsPj9PCCrF).
> Your working environment may not be exactly the same as what you see in the videos or documentation, just try to adapt your work according to your research and discoveries.
> Don't be afraid to try!
@@ -52,7 +52,7 @@ Choose a power that you will give to your robot from the following list and put
#### The `` part:
-This section contains the content of your webpage , in our case the lower body of your buddy. Define the skeleton of your robot by organizing it into three main sections: the face, the upper body, and the lower body. Inside the tag of your HTML file, create three divisions using tags, and place the following text content inside each one: face, upper-body, lower-body.
+This section contains the content of your webpage , in our case the lower body of your buddy. Define the skeleton of your robot by organizing it into three main sections: the face, the upper body, and the lower body. Inside the `` tag of your HTML file, create three divisions using `` tags, and place the following text content inside each one: face, upper-body, lower-body.
> Don't forget to press Render again to refresh the display page when you modify your code.
diff --git a/subjects/DPxAI/the-smooth-operator/README.md b/subjects/AI.GO/the-smooth-operator/README.md
similarity index 100%
rename from subjects/DPxAI/the-smooth-operator/README.md
rename to subjects/AI.GO/the-smooth-operator/README.md
diff --git a/subjects/DPxAI/transform-objects/README.md b/subjects/AI.GO/transform-objects/README.md
similarity index 91%
rename from subjects/DPxAI/transform-objects/README.md
rename to subjects/AI.GO/transform-objects/README.md
index e3f8619f1..c9da92e96 100644
--- a/subjects/DPxAI/transform-objects/README.md
+++ b/subjects/AI.GO/transform-objects/README.md
@@ -65,14 +65,14 @@ robot.code = undefined;
Modify the provided `robot` variable:
- Add a `model` property with the string value 'RX-78'.
-- Add a `fullName` property that is the joined value of the `brand` and the `model` with a space in between.
+- Add a `fullName` property that is the joined value of the `brand` and the `model` with a space in between. (`brand` and `model`are already defined in the provided `robot`)
- Add `10` to its `batteryLevel` property.
#### Task 2:
Let's move away from objects a bit, and discover a notion we will use later. `Duplicating a String with Placeholders`!
-Declare a variable `duplicate` that repeats the provided variable `sentence`, separated by a comma, and adds an exclamation mark at the end.
+Declare a variable `duplicate` that repeats the provided variable `sentence`, separated by a comma and a space, and then adds an exclamation mark at the end.
> For example, if `sentence` is "Hello there", we expect "Hello there, Hello there!".
diff --git a/subjects/ai/backtesting-sp500/README.md b/subjects/ai/backtesting-sp500/README.md
index 54fca3fb9..b9c59167d 100644
--- a/subjects/ai/backtesting-sp500/README.md
+++ b/subjects/ai/backtesting-sp500/README.md
@@ -1,10 +1,31 @@
-# Backtesting on the SP500
+## Backtesting-SP500
-## SP500 data preprocessing
+### Overview
The goal of this project is to perform a Backtest on the SP500 constituents, which represents the 500 largest companies by market capitalization in the United States.
-## Data
+### Role Play
+
+You are a quantitative analyst at a prestigious hedge fund. Your manager has tasked you with developing and backtesting a stock-picking strategy using historical data from the S&P 500 index. The goal is to create a strategy that outperforms the market benchmark. You'll need to clean and preprocess messy financial data, develop a signal for stock selection, implement a backtesting framework, and present your findings to the investment committee.
+
+### Learning Objectives
+
+By the end of this project, you will be able to:
+
+1. Optimize data types in large datasets to improve memory efficiency
+2. Perform exploratory data analysis on financial time series data
+3. Identify and handle outliers and missing values in stock price data
+4. Preprocess financial data, including resampling and calculating returns
+5. Develop a simple stock selection signal based on historical performance
+6. Implement a backtesting framework for evaluating trading strategies
+7. Compare the performance of a custom strategy against a market benchmark
+8. Visualize financial performance data using appropriate charts and graphs
+9. Write modular, reusable code for financial data analysis and strategy testing
+10. Interpret and communicate the results of a quantitative trading strategy
+
+### Instructions
+
+#### Data
The input files are:
@@ -24,42 +45,15 @@ _Note: The quality of this data set is not good: some prices are wrong, there ar
_Note: The corrections will not fix the data, as a result the results may be abnormal compared to results from cleaned financial data. That's not a problem for this small project !_
-## Problem
+#### Problem
Once preprocessed this data, it will be used to generate a signal that is, for each asset at each date a metric that indicates if the asset price will increase the next month. At each date (once a month) we will take the 20 highest metrics and invest $1 per company. This strategy is called **stock picking**. It consists in picking stock in an index and try to over perform the index. Finally, we will compare the performance of our strategy compared to the benchmark: the SP500
It is important to understand that the SP500 components change over time. The reason is simple: Facebook entered the SP500 in 2013 thus meaning that another company had to be removed from the 500 companies.
-The structure of the project is:
-
-```console
-project
-│ README.md
-│ environment.yml
-│
-└───data
-│ │ sp500.csv
-│ | prices.csv
-│
-└───notebook
-│ │ analysis.ipynb
-|
-|───scripts
-| │ memory_reducer.py
-| │ preprocessing.py
-| │ create_signal.py
-| | backtester.py
-│ | main.py
-│
-└───results
- │ plots
- │ results.txt
- │ outliers.txt
-```
-
There are four parts:
-## 1. Preliminary
+#### 1. Preliminary
- Create a function that takes as input one CSV data file. This function should optimize the types to reduce its size and returns a memory optimized DataFrame.
- For `float` data the smaller data type used is `np.float32`
@@ -71,7 +65,7 @@ There are four parts:
4. Find the min and the max value
5. Determine and apply the smallest datatype that can fit the range of values
-## 2. Data wrangling and preprocessing
+#### 2. Data wrangling and preprocessing
- Create a Jupyter Notebook to analyze the data sets and perform EDA (Exploratory Data Analysis). This notebook should contain at least:
@@ -112,7 +106,7 @@ At this stage the DataFrame should look like this:
- Resample data on month and keep the last value
- Compute historical monthly returns on the adjusted close
-## 3. Create signal
+#### 3. Create signal
At this stage we have a data set with features that we will leverage to get an investment signal. As previously said, we will focus on one single variable to create the signal: **monthly_past_return**. The signal will be the average of monthly returns of the previous year
@@ -121,7 +115,7 @@ The naive assumption made here is that if a stock has performed well the last ye
- Create a column `average_return_1y`
- Create a column named `signal` that contains `True` if `average_return_1y` is among the 20 highest in the month `average_return_1y`.
-## 4. Backtester
+#### 4. Backtester
At this stage we have an investment signal that indicates each month what are the 20 companies we should invest 1$ on (1$ each). In order to check the strategies and performance we will backtest our investment signal.
@@ -135,9 +129,9 @@ A data point (x-axis: date, y-axis: cumulated_return) is: the **cumulated return
![alt text][performance]
-[performance]: images/w1_weekend_plot_pnl.png 'Cumulative Performance'
+[performance]: images/w1_weekend_plot_pnl.png "Cumulative Performance"
-## 5. Main
+#### 5. Main
Here is a sketch of `main.py`.
@@ -158,3 +152,83 @@ backtest(prices, sp500)
```
**The command `python main.py` executes the code from data imports to the backtest and save the results.**
+
+### Project repository structure:
+
+```console
+project
+│ README.md
+│ requirements.txt
+│
+└───data
+│ │ sp500.csv
+│ | prices.csv
+│
+└───notebook
+│ │ analysis.ipynb
+|
+|───scripts
+| │ memory_reducer.py
+| │ preprocessing.py
+| │ create_signal.py
+| | backtester.py
+│ | main.py
+│
+└───results
+ │ plots
+ │ results.txt
+ │ outliers.txt
+```
+
+### Tips:
+
+1. Data Quality Management:
+
+ - Be prepared to encounter messy data. Financial datasets often contain errors, outliers, and missing values.
+ - Develop a systematic approach to identify and handle data quality issues.
+
+2. Memory Optimization:
+
+ - When working with large datasets, optimize memory usage by selecting appropriate data types for each column.
+ - Consider using smaller data types like np.float32 for floating-point numbers when precision allows.
+
+3. Exploratory Data Analysis:
+
+ - Spend time understanding the data through visualization and statistical analysis before diving into strategy development.
+ - Pay special attention to outliers and their potential impact on your strategy.
+
+4. Preprocessing Financial Data:
+
+ - When resampling time series data, be mindful of which value to keep (e.g., last value for month-end prices).
+ - Calculate both historical and future returns to avoid look-ahead bias in your strategy.
+
+5. Handling Outliers:
+
+ - Develop a method to identify and handle outliers that is specific to each company's historical data.
+ - Be cautious about removing outliers during periods of high market volatility (e.g., 2008-2009 financial crisis).
+
+6. Signal Creation:
+
+ - Start with a simple signal (like past 12-month average returns) before exploring more complex strategies.
+ - Ensure your signal doesn't use future information that wouldn't have been available at the time of decision.
+
+7. Backtesting:
+
+ - Implement your backtesting logic without using loops for better performance.
+ - Compare your strategy's performance against a relevant benchmark (in this case, the S&P 500).
+
+8. Visualization:
+
+ - Create clear, informative visualizations to communicate your strategy's performance.
+ - Include cumulative return plots to show how your strategy performs over time compared to the benchmark.
+
+9. Code Structure:
+
+ - Organize your code into modular functions for better readability and reusability.
+ - Use a main script to orchestrate the entire process from data loading to results visualization.
+
+10. Results Interpretation:
+ - Don't just focus on total returns. Consider other metrics like risk-adjusted returns, maximum drawdown, etc.
+ - Be prepared to explain any anomalies or unexpected results in your strategy's performance.
+
+Remember, the goal is not just to create a strategy that looks good on paper, but to develop a robust process for analyzing financial data and testing investment ideas.
diff --git a/subjects/ai/backtesting-sp500/audit/README.md b/subjects/ai/backtesting-sp500/audit/README.md
index fdf200d93..27ba69dac 100644
--- a/subjects/ai/backtesting-sp500/audit/README.md
+++ b/subjects/ai/backtesting-sp500/audit/README.md
@@ -1,11 +1,11 @@
-#### Functional
+#### Backtesting-SP500
###### Is the structure of the project as below?
```
project
│ README.md
-│ environment.yml
+│ requirements.txt
│
└───data
│ │ sp500.csv
@@ -30,7 +30,7 @@ project
###### Does the readme file contain a description of the project, explain how to run the code from an empty environment, give a summary of the implementation of each python file and contain a conclusion that gives the performance of the strategy?
-###### Does the environment contain all libraries used and their versions that are necessary to run the code?
+###### Does the requirements contain all libraries used and their versions that are necessary to run the code?
###### Does the notebook contain a missing values analysis? **Example**: number of missing values per variables or per year
@@ -107,7 +107,7 @@ Best practice:
![alt text][performance]
-[performance]: ../images/w1_weekend_plot_pnl.png 'Cumulative Performance'
+[performance]: ../images/w1_weekend_plot_pnl.png "Cumulative Performance"
##### 5. main.py
diff --git a/subjects/ai/credit-scoring/README.md b/subjects/ai/credit-scoring/README.md
index d74008b31..3ed8741a7 100644
--- a/subjects/ai/credit-scoring/README.md
+++ b/subjects/ai/credit-scoring/README.md
@@ -1,16 +1,24 @@
## Credit scoring
+### Overview
+
The goal of this project is to implement a scoring model based on various source of data ([check data documentation](./readme_data.md)) that returns the probability of default. In a nutshell, credit scoring represents an evaluation of how well the bank's customer can pay and is willing to pay off debt. It is also required that you provide an explanation of the score. For example, your model returns that the probability that one client doesn't pay back the loan is very high (90%). The reason behind is that variable_xxx which represents the ability to pay back the past loan is low. The output interpretability will appear in a visualization.
-The ability to understand the underlying factors of credit scoring is important. Credit scoring is subject to more and more regulation, so transparency is key. And more generally, more and more companies prefer transparency to black box models.
+### Role play
-### Resources
+Hey there, future credit scoring expert! Ready to dive into the exciting world of predicting loan defaults? You're in for a treat! This project is all about building a nifty model that can help figure out how likely someone is to pay back their loan. Cool, right?
+
+### Learning Objective
+
+The ability to understand the underlying factors of credit scoring is important. Credit scoring is subject to more and more regulation, so transparency is key. And more generally, more and more companies prefer transparency to black box models.
Historical timeline of machine learning techniques applied to credit scoring
- [Machine Learning or Econometrics for Credit Scoring: Let’s Get the Best of Both Worlds](https://hal.archives-ouvertes.fr/hal-02507499v3/document)
-### Scoring model
+### Instructions
+
+#### Scoring model
There are 3 expected deliverables associated with the scoring model:
@@ -18,21 +26,28 @@ There are 3 expected deliverables associated with the scoring model:
- The trained machine learning model with the features engineering pipeline:
- Do not forget: **Coming up with features is difficult, time-consuming, requires expert knowledge. ‘Applied machine learning’ is basically feature engineering.**
- - The model is validated if the **AUC on the test set is higher than 75%**.
+ - The model is validated if the **AUC on the test set is at minimum 55%, ideally to 62% included (or in best cases higher than 62% if you can !)**.
- The labelled test data is not publicly available. However, a Kaggle competition uses the same data. The procedure to evaluate test set submission is the same as the one used for the project 1.
+ - Here are the [DataSets](https://assets.01-edu.org/ai-branch/project5/home-credit-default-risk.zip).
+
+- A report on model training and evaluation:
+
+ - Include learning curves (training and validation scores vs. training set size or epochs) to demonstrate that the model is not overfitting.
+ - Explain the measures taken to prevent overfitting, such as early stopping or regularization techniques.
+ - Justify your choice of when to stop training based on the learning curves.
-### Kaggle submission
+#### Kaggle submission
The way the Kaggle platform works is explained in the challenge overview page. If you need more details, I suggest [this resource](https://towardsdatascience.com/getting-started-with-kaggle-f9138b35ae18) that gives detailed explanations.
- Create a username following that structure: username*01EDU* location_MM_YYYY. Submit the description profile and push it on the Git platform the first day of the week. Do not touch this file anymore.
-- A text document that describes the methodology used to train the machine learning model:
+- A text document `model_report.txt` that describes the methodology used to train the machine learning model :
- Algorithm
- Why the accuracy shouldn't be used in that case?
- Limit and possible improvements
-### Model interpretability
+#### Model interpretability
This part hasn't been covered during the piscine. Take the time to understand this key concept.
There are different level of transparency:
@@ -55,16 +70,16 @@ Choose the 3 clients of your choice, compute the score, run the visualizations o
- 1 on which the model is correct and the other on which the model is wrong. Try to understand why the model got wrong on this client.
- Take 1 client from the test set
-### Optional
+#### Bonus
Implement a dashboard (using [Dash](https://dash.plotly.com/)) that takes as input the customer id and that returns the score and the required visualizations.
-### Deliverables
+### Project repository structure:
```
project
│ README.md
-│ environment.yml
+│ requirements.txt
│
└───data
│ │ ...
@@ -93,17 +108,17 @@ project
│ │ preprocess.py
```
-- `README.md` introduces the project and shows the username.
-- `environment.yml` contains all libraries required to run the code.
+- `README.md` introduces the project, how to run the code, and shows the username.
+- `requirements.txt` contains all libraries required to run the code.
- `username.txt` contains the username, the last modified date of the file **has to correspond to the first day of the project**.
- `EDA.ipynb` contains the exploratory data analysis. This file should contain all steps of data analysis that contributed or not to improve the score of the model. It has to be commented so that the reviewer can understand the analysis and run it without any problem.
- `scripts` contains python file(s) that perform(s) the feature engineering, the model's training and prediction on the test set. It could also be one single Jupyter Notebook. It has to be commented to help the reviewers understand the approach and run the code without any bugs.
-### Useful resources
+### Tips
-- [Interpreting machine learning models](https://towardsdatascience.com/interpretability-in-machine-learning-70c30694a05f)
+Remember, creating a great credit scoring model is like baking a perfect cake - it takes the right ingredients, careful preparation, and a dash of creativity. You've got this!
-### Files needed for this project
+### Resources
-[Files](https://assets.01-edu.org/ai-branch/project5/home-credit-default-risk.zip)
+- [Interpreting machine learning models](https://towardsdatascience.com/interpretability-in-machine-learning-70c30694a05f)
diff --git a/subjects/ai/credit-scoring/audit/README.md b/subjects/ai/credit-scoring/audit/README.md
index 0c363cdd8..7eba4ec1f 100644
--- a/subjects/ai/credit-scoring/audit/README.md
+++ b/subjects/ai/credit-scoring/audit/README.md
@@ -5,7 +5,7 @@
```
project
│ README.md
-│ environment.yml
+│ requirements.txt
│
└───data
│ │ ...
@@ -38,7 +38,7 @@ project
###### Does the readme file introduce the project, summarize how to run the code and show the username?
-###### Does the environment contain all libraries used and the versions that are necessary to run the code?
+###### Does the requirements contain all libraries used and the versions that are necessary to run the code?
###### Does the `EDA.ipynb` explain in details the exploratory data analysis?
@@ -46,7 +46,7 @@ project
###### Is the model trained only the training set?
-###### Is the AUC on the test set higher than 75%?
+###### Is the AUC on the test set is between 55% (included) to 62%(included) or higher than 62%?
###### Does the model learning curves prove that the model is not overfitting?
@@ -59,7 +59,7 @@ project
```prompt
python predict.py
- AUC on test set: 0.76
+ AUC on test set: 0.62
```
@@ -75,11 +75,13 @@ This [article](https://medium.com/thecyphy/home-credit-default-risk-part-2-84b58
### Descriptive variables:
-###### These are important to understand for example the age of the client. If the data could be scaled or modified in the preprocessing pipeline but the data visualised here should be "raw". Are the visualisations computed for the 3 clients?
+##### These are important to understand for example the age of the client. If the data could be scaled or modified in the preprocessing pipeline but the data visualized here should be "raw".
- Visualisations that show at least 10 variables describing the client and its loan(s).
- Visualisations that show the comparison between this client and other clients.
+###### Are the visualisations computed for the 3 clients?
+
##### SHAP values on the model are displayed through a summary plot that shows the important features and their impact on the target. This is optional if you have already computed the features importance.
###### Are the 3 clients selected as expected? 2 clients from the train set (1 on which the model is correct and 1 on which the model's wrong) and 1 client from the test set.
diff --git a/subjects/ai/credit-scoring/readme_data.md b/subjects/ai/credit-scoring/readme_data.md
index 12aa9509c..8682b10e3 100644
--- a/subjects/ai/credit-scoring/readme_data.md
+++ b/subjects/ai/credit-scoring/readme_data.md
@@ -4,7 +4,7 @@ This file describes the available data for the project.
-## application_{train|test}.csv
+## application\_{train|test}.csv
This is the main table, broken into two files for Train (with TARGET) and Test (without TARGET).
Static data for all applications. One row represents one loan in our data sample.
@@ -17,24 +17,23 @@ For every loan in our sample, there are as many rows as number of credits the cl
## bureau_balance.csv
Monthly balances of previous credits in Credit Bureau.
-This table has one row for each month of history of every previous credit reported to Credit Bureau – i.e the table has (#loans in sample * # of relative previous credits * # of months where we have some history observable for the previous credits) rows.
+This table has one row for each month of history of every previous credit reported to Credit Bureau – i.e the table has (#loans in sample _ # of relative previous credits _ # of months where we have some history observable for the previous credits) rows.
## POS_CASH_balance.csv
Monthly balance snapshots of previous POS (point of sales) and cash loans that the applicant had with Home Credit.
-This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample * # of relative previous credits * # of months in which we have some history observable for the previous credits) rows.
+This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample _ # of relative previous credits _ # of months in which we have some history observable for the previous credits) rows.
## credit_card_balance.csv
Monthly balance snapshots of previous credit cards that the applicant has with Home Credit.
-This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample * # of relative previous credit cards * # of months where we have some history observable for the previous credit card) rows.
+This table has one row for each month of history of every previous credit in Home Credit (consumer credit and cash loans) related to loans in our sample – i.e. the table has (#loans in sample _ # of relative previous credit cards _ # of months where we have some history observable for the previous credit card) rows.
## previous_application.csv
All previous applications for Home Credit loans of clients who have loans in our sample.
There is one row for each previous application related to loans in our data sample.
-
## installments_payments.csv
Repayment history for the previously disbursed credits in Home Credit related to the loans in our sample.
diff --git a/subjects/ai/emotions-detector/README.md b/subjects/ai/emotions-detector/README.md
index a0bd99839..f95b70dee 100644
--- a/subjects/ai/emotions-detector/README.md
+++ b/subjects/ai/emotions-detector/README.md
@@ -1,10 +1,18 @@
-## Emotions detection with Deep Learning
+## Emotion detector
+
+### Overview
Cameras are everywhere. Videos and images have become one of the most interesting data sets for artificial intelligence.
Image processing is a quite broad research area, not just filtering, compression, and enhancement.
Besides, we are even interested in the question, “what is in images?”, i.e., content analysis of visual inputs, which is part of the main task of computer vision.
+### Role play
+
+you're going to train a computer to be like a mind reader, but instead of reading thoughts, it's reading emotions! You'll be working with a bunch of pictures of faces, teaching your AI to tell the difference between a big grin and a grumpy frown, or a surprised gasp and a fearful wide-eyed look.
+
+### Learning Objective
+
The study of computer vision could make possible such tasks as 3D reconstruction of scenes, motion capturing, and object recognition, which are crucial for even higher-level intelligence such as image and video understanding, and motion understanding.
For this project we will focus on two tasks:
@@ -18,7 +26,9 @@ With the computing power exponentially increasing the computer vision field has
- The history behind this field is fascinating! [Here](https://kapernikov.com/basic-introduction-to-computer-vision/) is a short summary of its history.
-### Project goal and suggested timeline
+### Instructions
+
+#### Project goal:
The goal of the project is to implement a **system that detects the emotion on a face from a webcam video stream**. To achieve this exciting task you'll have to understand how to:
@@ -32,7 +42,7 @@ Then starts the emotion detection in a webcam video stream step that will last u
The two steps are detailed below.
-### Preliminary:
+#### Preliminary:
- Take [this course](https://www.coursera.org/learn/convolutional-neural-networks). This course is a reference for many reasons and one of them is the creator: **Andrew Ng**. He explains the basics of CNNs but also some more advanced topics as transfer learning, siamese networks etc ...
- I suggest to focus on Week 1 and 2 and to spend less time on Week 3 and 4. Don't worry the time scoping of such MOOCs are conservative. You can attend the lessons for free!
@@ -41,7 +51,7 @@ The two steps are detailed below.
- Start first with a logistic regression to understand how to handle images in Python. And then train your first CNN on this data set.
-### Face emotions classification
+#### Face emotions classification
Emotion detection is one of the most researched topics in the modern-day machine learning arena. The ability to accurately detect and identify an emotion opens up numerous doors for Advanced Human Computer Interaction.
The aim of this project is to detect up to seven distinct facial emotions in real time.
@@ -57,7 +67,7 @@ Your goal is to implement a program that takes as input a video stream that cont
This dataset was provided for this past [Kaggle challenge](https://www.kaggle.com/competitions/challenges-in-representation-learning-facial-expression-recognition-challenge/overview).
It is possible to find more information about on the challenge page. Train a CNN on the dataset `train.csv`. Here is an [example of architecture](https://www.quora.com/What-is-the-VGG-neural-network) you can implement.
**The CNN has to perform more than 60% on the test set**. You can use the `test_with_emotions.csv` file for this. You will see that the CNNs take a lot of time to train.
- You don't want to overfit the neural network. I strongly suggest to use early stopping, callbacks and to monitor the training using the `TensorBoard`.
+ You don't want to overfit the neural network. I strongly suggest to use early stopping, callbacks and to monitor the training using the `TensorBoard` 'note: Integrating TensorBoard is not optional'.
You have to save the trained model in `final_emotion_model.keras` and to explain the chosen architecture in `final_emotion_model_arch.txt`. Use `model.summary())` to print the architecture.
It is also expected that you explain the iterations and how you end up choosing your final architecture. Save a screenshot of the `TensorBoard` while the model's training in `tensorboard.png` and save a plot with the learning curves showing the model training and stopping BEFORE the model starts overfitting in `learning_curves.png`.
@@ -82,7 +92,7 @@ For that step, I suggest again to use **OpenCV** as much as possible. This link
- Optional: **(very cool)** Hack the CNN. Take a picture for which the prediction of your CNN is **Happy**. Now, hack the CNN: using the same image **SLIGHTLY** modified make the CNN predict **Sad**.
You can find an example on how to achieve this in [this article](https://medium.com/@ageitgey/machine-learning-is-fun-part-8-how-to-intentionally-trick-neural-networks-b55da32b7196)
-### Deliverable
+### Project repository structure:
```
project
@@ -90,7 +100,7 @@ project
│ ├── test.csv
│ ├── train.csv
│ └── xxx.csv
-├── environment.yml
+├── requirements.txt
├── README.md
├── results
│ ├── model
@@ -148,14 +158,16 @@ Preprocessing ...
```
-### Useful resources:
+### Tips
+
+Balance technical prowess with psychological insight: as you fine-tune your CNN and optimize your video processing, remember that understanding the nuances of human facial expressions is key to creating a truly effective emotion detection system.
-- https://machinelearningmastery.com/what-is-computer-vision/
+### Resources
-- Use a pre-trained CNN: https://arxiv.org/pdf/1812.06387.pdf
+- [What is computer vision](https://machinelearningmastery.com/what-is-computer-vision/)
-- Hack the CNN https://medium.com/@ageitgey/machine-learning-is-fun-part-8-how-to-intentionally-trick-neural-networks-b55da32b7196
+- [Use a pre-trained CNN](https://arxiv.org/pdf/1812.06387.pdf)
-- http://ice.dlut.edu.cn/valse2018/ppt/WeihongDeng_VALSE2018.pdf
+- [Hack the CNN](https://medium.com/@ageitgey/machine-learning-is-fun-part-8-how-to-intentionally-trick-neural-networks-b55da32b7196)
-- https://arxiv.org/pdf/1812.06387.pdf
+- [Convolutional Neural Network](https://arxiv.org/pdf/1812.06387.pdf)
diff --git a/subjects/ai/emotions-detector/audit/README.md b/subjects/ai/emotions-detector/audit/README.md
index fe2a21df0..3fb9a7867 100644
--- a/subjects/ai/emotions-detector/audit/README.md
+++ b/subjects/ai/emotions-detector/audit/README.md
@@ -1,4 +1,4 @@
-#### Computer vision
+#### Emotion detector
##### Preliminary
@@ -14,7 +14,7 @@
###### Is the model trained only the training set?
-###### Is the accuracy on the test set higher than 70%?
+###### Is the accuracy on the test set higher than 60%?
###### Do the learning curves prove that the model is not overfitting?
diff --git a/subjects/ai/kaggle-titanic/README.md b/subjects/ai/kaggle-titanic/README.md
index 0f31e79a7..9e1c8f64c 100644
--- a/subjects/ai/kaggle-titanic/README.md
+++ b/subjects/ai/kaggle-titanic/README.md
@@ -1,6 +1,6 @@
-# Your first Kaggle: Titanic
+## Kaggle Titanic
-### Introduction
+### Overview
The goal of this **1 week** project is to get the highest possible score on a Data Science competition. More precisely you will have to predict who survived the Titanic crash.
@@ -8,11 +8,11 @@ The goal of this **1 week** project is to get the highest possible score on a Da
[titanic]: titanic.jpg "Titanic"
-### Kaggle
+#### Kaggle
Kaggle is an online community of data scientists and machine learning practitioners. Kaggle allows users to find and publish data sets, explore and build models in a web-based data-science environment, work with other data scientists and machine learning engineers, and enter competitions to solve data science challenges. It’s a crowd-sourced platform to attract, nurture, train and challenge data scientists from all around the world to solve data science, machine learning and predictive analytics problems.
-### Titanic - Machine Learning from Disaster
+#### Titanic - Machine Learning from Disaster
One of the first Kaggle competition I did was: Titanic - Machine Learning from Disaster. This is a not-to-be-missed Kaggle competition.
@@ -22,47 +22,28 @@ The sinking of the Titanic is one of the most infamous shipwrecks in history. On
While there was some element of luck involved in surviving, it seems some groups of people were more likely to survive than others.
-In this challenge, you have to build a predictive model that answers the question: **“what sorts of people were more likely to survive?”** using passenger data (ie name, age, gender, socio-economic class, etc). **You will have to submit your prediction on Kaggle**.
-
-### Preliminary
-
-The way the Kaggle platform works is explained in the challenge overview page. If you need more details, I suggest this [resource](https://towardsdatascience.com/getting-started-with-kaggle-f9138b35ae18) that gives detailed explanations.
-
-- Create a username following this structure: username*01EDU* location_MM_YYYY. Submit the description profile and push it on GitHub the first day of the week. Do not touch this file anymore.
-
-- It is possible to have different personal accounts merged in a team for one single competition.
+### Role play
-### Deliverables
+Ahoy, data explorer! Ready to set sail on the most thrilling voyage of your data science career? Welcome aboard the Kaggle Titanic challenge! You're about to embark on a journey through time, back to that fateful night in 1912.
+Your mission, should you choose to accept it (and let's face it, you're already hooked), is to dive deep into the passenger manifest and uncover the secrets of survival. Who lived? Who perished? And most importantly, can you build a model that predicts it all?
-```console
-project
-│ README.md
-│ environment.yml
-│ username.txt
-│
-└───data
-│ │ train.csv
-│ | test.csv
-| | gender_submission.csv
-│
-└───notebook
-│ │ main.ipynb
+### Learning Objective
+In this challenge, you have to build a predictive model that answers the question: **“what sorts of people were more likely to survive?”** using passenger data (ie name, age, gender, socio-economic class, etc). **You will have to submit your prediction on Kaggle**.
-```
+### Instructions
-- `README.md` introduction of the project, shows the username, describes the features engineering and the best score on the **leaderboard**. Note the score on the test set using the exact same pipeline that led to the best score on the leaderboard.
+#### Preliminary
-- `environment.yml` contains all libraries required to run the code.
+The way the Kaggle platform works is explained in the challenge overview page. If you need more details, I suggest this [resource](https://www.kaggle.com/code/alexisbcook/getting-started-with-kaggle) that gives detailed explanations.
-- `username.txt` contains the username, the last modified date of the file **has to correspond to the first day of the project**.
+- Create a username following this structure: username*01EDU* location_MM_YYYY. Submit the description profile and push it on GitHub the first day of the week. Do not touch this file anymore.
-- `main.ipynb` This file (single Jupyter Notebook) should contain all steps of data analysis that contributed or not to improve the accuracy, the feature engineering, the model's training and prediction on the test set. It has to be commented to help the reviewers understand the approach and run the code without any bugs.
-- **Submit your predictions on the Kaggle's competition platform**. Check your ranking and score in the leaderboard.
+- It is possible to have different personal accounts merged in a team for one single competition.
-### Scores
+#### Scores
-In order to validate the project you will have to score at least **79% accuracy on the Leaderboard**:
+In order to validate the project you will have to score at least **78.9% accuracy on the Leaderboard**:
- 78.9% accuracy is the minimum score to validate the project.
@@ -75,20 +56,48 @@ Scores indication:
#### Cheating
-It is impossible to get 100%. Who would have predicted that Rose wouldn't let [Jack on the door](https://www.insider.com/jack-and-rose-werent-on-a-door-in-titanic-2019-7) ?
+It is impossible to get 100%. Who would have predicted that Rose wouldn't let [Jack on the door](https://www.reddit.com/r/titanic/comments/14i0v5j/for_all_the_newbies_proof_its_not_a_door/?rdt=35268) ?
All people having 100% of accuracy on the Leaderboard cheated, there's no point to compare with them or to cheat. The Kaggle community estimates that having more than 85% is almost considered as cheated submissions as they are element of luck involved in the surviving.
**You can't use external data sets than the ones provided in that competition.**
-### The key points
+#### The key points
- **Feature engineering**:
Put yourself in the shoes of an investigator trying to understand what happened exactly in that boat during the crash. Do not hesitate to watch the movie to try to find as many insights as possible. Without a smart the feature engineering there's no way to validate the project ;-)
- The leaderboard evaluates on test data for which you don't have the labels. It means that there's no point to over fit the train set. Check the over fitting on the train set by dividing the data and by cross-validating the accuracy.
-### Advice
+### Project repository structure
+
+```console
+project
+│ README.md
+│ requirements.txt
+│ username.txt
+│
+└───data
+│ │ train.csv
+│ | test.csv
+| | gender_submission.csv
+│
+└───notebook
+│ │ main.ipynb
+
+
+```
+
+- `README.md` introduction of the project, shows the username, describes the features engineering and the best score on the **leaderboard**. Note the score on the test set using the exact same pipeline that led to the best score on the leaderboard.
+
+- 'requirements.txt` contains all libraries required to run the code.
+
+- `username.txt` contains the username, the last modified date of the file **has to correspond to the first day of the project**.
+
+- `main.ipynb` This file (single Jupyter Notebook) should contain all steps of data analysis that contributed or not to improve the accuracy, the feature engineering, the model's training and prediction on the test set. It has to be commented to help the reviewers understand the approach and run the code without any bugs.
+- **Submit your predictions on the Kaggle's competition platform**. Check your ranking and score in the leaderboard.
+
+### Tips
Don't try to build the perfect model the first day. Iterate a lot and test your assumptions:
diff --git a/subjects/ai/kaggle-titanic/audit/README.md b/subjects/ai/kaggle-titanic/audit/README.md
index 78dda58e1..363b2bcad 100644
--- a/subjects/ai/kaggle-titanic/audit/README.md
+++ b/subjects/ai/kaggle-titanic/audit/README.md
@@ -1,4 +1,4 @@
-#### First Kaggle: Titanic
+#### Kaggle Titanic
##### Preliminary
@@ -43,7 +43,7 @@ project
#### Final score
-###### Is the accuracy associated with the username in `username.txt` higher than 79%? The best submission score can be accessed from the user profile.
+###### Is the accuracy associated with the username in `username.txt` higher than 78.9%? The best submission score can be accessed from the user profile.
#### Examples
diff --git a/subjects/ai/nlp-scraper/README.md b/subjects/ai/nlp-scraper/README.md
index b7c1741fc..71209fb80 100644
--- a/subjects/ai/nlp-scraper/README.md
+++ b/subjects/ai/nlp-scraper/README.md
@@ -1,4 +1,4 @@
-## NLP-enriched News Intelligence platform
+## NLP Scraper
The goal of this project is to build an NLP-enriched News Intelligence
platform. News analysis is a trending and important topic. The analysts get
@@ -10,7 +10,25 @@ The platform connects to a news data source, detects the entities, detects the
topic of the article, analyses the sentiment and performs a scandal detection
analysis.
-### Scraper
+### Role Play
+
+You're a Natural Language Processing (NLP) specialist at a tech startup developing a sentiment analysis tool for social media posts. Your task is to build the preprocessing pipeline and create a bag-of-words representation for tweet analysis.
+
+### Learning Objectives
+
+1. Set up an NLP-focused Python environment
+2. Implement basic text preprocessing techniques (lowercase, punctuation removal)
+3. Perform text tokenization at sentence and word levels
+4. Remove stop words from text data
+5. Apply stemming to reduce words to their root forms
+6. Create a complete text preprocessing pipeline
+7. Implement a bag-of-words model using CountVectorizer
+8. Analyze word frequency in a corpus of tweets
+9. Prepare a labeled dataset for sentiment analysis
+
+### Instructions
+
+#### Scraper
News data source:
@@ -29,7 +47,7 @@ Use data from the last week otherwise the volume may be too high.
There should be at least 300 articles stored in your file system or SQL
database.
-### NLP engine
+#### NLP engine
In production architectures, the NLP engine delivers a live output based on the
news that are delivered in a live stream data by the scraper. However, it
@@ -41,7 +59,7 @@ the stored data.
Here how the NLP engine should process the news:
-#### **1. Entities detection:**
+##### **1. Entities detection:**
The goal is to detect all the entities in the document (headline and body). The
type of entity we focus on is `ORG`. This corresponds to companies and
@@ -52,7 +70,7 @@ organizations. This information should be stored.
[Named Entity Recognition with NLTK and
SpaCy](https://towardsdatascience.com/named-entity-recognition-with-nltk-and-spacy-8c4a7d88e7da)
-#### **2. Topic detection:**
+##### **2. Topic detection:**
The goal is to detect what the article is dealing with: Tech, Sport, Business,
Entertainment or Politics. To do so, a labelled dataset is provided: [training
@@ -68,7 +86,7 @@ that the model is trained correctly and not overfitted.
- Learning constraints: **Score on test: > 95%**
-#### **3. Sentiment analysis:**
+##### **3. Sentiment analysis:**
The goal is to detect the sentiment (positive, negative or neutral) of the news
articles. To do so, use a pre-trained sentiment model. I suggest to use:
@@ -82,7 +100,7 @@ articles. To do so, use a pre-trained sentiment model. I suggest to use:
- [Sentiment analysis](https://en.wikipedia.org/wiki/Sentiment_analysis)
-#### **4. Scandal detection**
+##### **4. Scandal detection**
The goal is to detect environmental disaster for the detected companies. Here
is the methodology that should be used:
@@ -107,7 +125,7 @@ is the methodology that should be used:
- Flag the top 10 articles.
-#### 5. **Source analysis (optional)**
+##### 5. **Source analysis (optional)**
The goal is to show insights about the news' source you scraped.
This requires to scrap data on at least 5 days (a week ideally). Save the plots
@@ -127,7 +145,7 @@ Here are examples of insights:
- Companies mentioned the most
- Sentiment per companies
-### Deliverables
+### Project repository structure:
The expected structure of the project is:
@@ -137,6 +155,7 @@ project
├── data
│ └── ...
├── nlp_enriched_news.py
+├── requirements.txt
├── README.md
├── results
│ ├── training_model.py
@@ -212,7 +231,7 @@ python scraper_news.py
Environmental scandal detected for
```
-### Notions
+### Resources
- [Web Scraping](https://www.youtube.com/watch?v=XVv6mJpFOb0)
- [Sentiment analysis](https://en.wikipedia.org/wiki/Sentiment_analysis)
diff --git a/subjects/ai/nlp-scraper/audit/README.md b/subjects/ai/nlp-scraper/audit/README.md
index e38aa8144..225dbeba4 100644
--- a/subjects/ai/nlp-scraper/audit/README.md
+++ b/subjects/ai/nlp-scraper/audit/README.md
@@ -1,4 +1,4 @@
-#### NLP-enriched News Intelligence platform
+#### NLP Scraper
##### Preliminary
diff --git a/subjects/ai/sp500-strategies/README.md b/subjects/ai/sp500-strategies/README.md
index b7d88c1ab..71e0767ee 100644
--- a/subjects/ai/sp500-strategies/README.md
+++ b/subjects/ai/sp500-strategies/README.md
@@ -1,4 +1,6 @@
-## Financial strategies on the SP500
+## SP500 strategies
+
+### Overview
In this project, you'll apply machine learning to finance. Your goal as a Quant/Data Scientist is to create a financial strategy that uses a signal generated by a machine learning model to outperform the [SP500](https://en.wikipedia.org/wiki/S%26P_500).
@@ -6,15 +8,19 @@ The S&P 500 Index is a collection of 500 stocks that represent the overall perfo
The S&P 500 started in 1926 with only 90 stocks and has grown to include 500 stocks since 1957. Historically, the average annual return of the S&P 500 has been about 10-11% since 1926, and around 8% since 1957.
+### Role play
+
As a Quantitative Researcher, your challenge is to develop a strategy that can consistently outperform the S&P 500, not just in one year, but over many years. This is a difficult task and is the primary goal of many hedge funds around the world.
-The project is divided in parts:
+### Learning Objective
- **Data processing and feature engineering**: Build a dataset: insightful features and the target
- **Machine Learning pipeline**: Train machine learning models on the dataset, select the best model and generate the machine learning signal.
- **Strategy backtesting**: Generate a strategy from the Machine Learning model output and backtest the strategy. As a reminder, the idea here is to see what would have performed the strategy if you had invested.
-### Data processing and features engineering
+### Instructions
+
+#### Data processing and features engineering
The file `HistoricalData.csv` contains the open-high-low-close (OHLC) SP500 index data and the other file, `all_stocks_5yr.csv`, contains the open-high-low-close-volume (OHLCV) data on the SP500 constituents.
@@ -42,7 +48,7 @@ We assume it is day `D`, and we want to take a position on the next n days. The
> Remark: The target used is the return computed on the price and not the price directly. There are statistical reasons for this choice - the price is not stationary. The consequence is that a machine learning model tends to overfit while training on not stationary data.
-### Machine learning pipeline
+#### Machine learning pipeline
- Cross-validation deliverables:
- Implements a cross validation with at least 10 folds. The train set has to be bigger than 2 years history.
@@ -80,7 +86,7 @@ Once you'll have run the grid search on the cross validation (choose either Bloc
- (optional): [Train an RNN/LSTM](https://towardsdatascience.com/predicting-stock-price-with-lstm-13af86a74944). This is a nice way to discover and learn about recurrent neural networks. But keep in mind that there are some new neural network architectures that seem to outperform recurrent neural networks. Here is an [interesting article](https://towardsdatascience.com/the-fall-of-rnn-lstm-2d1594c74ce0) about the topic.
-### Strategy backtesting
+#### Strategy backtesting
- Backtesting module deliverables. The module takes as input a machine learning signal, convert it into a financial strategy. A financial strategy DataFrame gives the amount invested at time `t` on asset `i`. The module returns the following metrics on the train set and the test set.
- Profit and Loss (PnL) plot: save it as `strategy.png`
@@ -107,7 +113,7 @@ Once you'll have run the grid search on the cross validation (choose either Bloc
- PnL plot
- strategy metrics on the train set and test set
-### Example of strategies:
+#### Example of strategies:
- Long only:
- Binary signal:
@@ -172,7 +178,7 @@ Here's an example on how to convert a machine learning signal into a financial s
project
├── data
│ └── sp500.csv
-├── environment.yml
+├── requirements.txt
├── README.md
├── results
│ ├── cross-validation
@@ -199,7 +205,10 @@ project
Note: `features_engineering.py` can be used in `gridsearch.py`
-### Files for this project
+### Tips
+
+Remember, the goal of this project is not just to beat the S&P 500 in a backtest, but to learn about the process of developing and testing trading strategies using machine learning techniques.
+
+### Resources
-You can find the data required for this project in this :
-[link](https://assets.01-edu.org/ai-branch/project4/project04-20221031T173034Z-001.zip)
+You can find the data required for this project in this : [link](https://assets.01-edu.org/ai-branch/project4/project04-20221031T173034Z-001.zip)
diff --git a/subjects/ai/sp500-strategies/audit/README.md b/subjects/ai/sp500-strategies/audit/README.md
index 5c5b361d4..499436301 100644
--- a/subjects/ai/sp500-strategies/audit/README.md
+++ b/subjects/ai/sp500-strategies/audit/README.md
@@ -1,4 +1,4 @@
-#### Financial strategies on the SP500
+#### SP500 strategies
###### Is the structure of the project like the one presented in the `Project repository structure` in the subject?
diff --git a/subjects/cybersecurity/image-inspector/README.md b/subjects/cybersecurity/image-inspector/README.md
index 777233ece..7a6a2d936 100644
--- a/subjects/cybersecurity/image-inspector/README.md
+++ b/subjects/cybersecurity/image-inspector/README.md
@@ -13,7 +13,7 @@ Images can contain more than just visual information, they often carry hidden da
The goal is to develop a tool using a programming language of your choice (Python is recommended) that can analyze images to extract hidden information. Specifically, your tool should:
1. **Extract Metadata**: Identify and display metadata from images, such as geolocation (latitude and longitude) where the photo was taken, the device used, and other relevant information.
-2. **Detect Steganography**: Discover and extract any hidden PGP keys or other data concealed within the image using steganography techniques.
+2. **Detect Steganography**: Discover and extract any hidden PGP keys within the image using steganography techniques.
By completing this project, you will:
@@ -101,7 +101,7 @@ Data saved in hidden_data.txt
```
**You will be provided with an example image to test your tool. Make sure your tool can successfully analyze this image and produce the expected outputs.**
-The example image attached:
+The example image attached:
[image-example1.jpeg](resources/image-example1.jpeg)
[image-example2.jpeg](resources/image-example2.jpeg)
[image-example3.jpeg](resources/image-example3.jpeg)
diff --git a/subjects/cybersecurity/image-inspector/audit/README.md b/subjects/cybersecurity/image-inspector/audit/README.md
index 03ad9adce..a31b381e1 100644
--- a/subjects/cybersecurity/image-inspector/audit/README.md
+++ b/subjects/cybersecurity/image-inspector/audit/README.md
@@ -22,8 +22,6 @@ Suggested role play questions include:
- How can this tool be used in real-life digital forensics or cybersecurity scenarios?
- What ethical considerations should be taken into account when analyzing images for hidden data?
-###### Were the students able to answer all the questions?
-
###### Did the students demonstrate a thorough understanding of the concepts and technologies used in the project?
###### Were the students able to communicate effectively and justify their decisions and explain the knowledge behind this project?
@@ -64,14 +62,14 @@ $> image-inspector -m -o metadata.txt image-example1.jpeg
$> image-inspector -s -o hidden_data.txt image-example1.jpeg
```
-###### Does the output correctly detect and extract any hidden PGP keys or other concealed information within the image?
+###### Does the output correctly detect and extract any hidden PGP keys within the image?
###### Is the output stored in the file specified in the output parameter?
##### Testing with Images
**You will be provided with an example image to test the students tool. Feel free to test with other images.**
-The example image attached:
+The example image attached:
[image-example1.jpeg](resources/image-example1.jpeg)
[image-example2.jpeg](resources/image-example2.jpeg)
[image-example3.jpeg](resources/image-example3.jpeg)
@@ -79,18 +77,47 @@ The example image attached:
###### Test the tool with the provided example image and at least one other image to ensure the tool's robustness.
-###### Does the tool produce accurate and expected results for different images?
+```sh
+$> image-inspector -s -o hidden_data1.txt image-example1.jpeg
+Enter -----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: 01
+
+mQENBGIwpy4BC<...>
+=N8hc
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
+
+```sh
+$> image-inspector -s -o hidden_data2.txt image-example2.jpeg
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+xo0EZuV9/AEEANRklh3<...>
+=BhsK
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
-##### Ensure that the student submission meets the project requirements:
+```sh
+$> image-inspector -s -o hidden_data3.txt image-example3.jpeg
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+xo0EZuWBWQEEALrj<...>
+=SXXm
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
-1. **Functionality:** Does the tool perform its intended functions accurately (metadata extraction and steganography detection)?
-2. **Data Accuracy:** Is the retrieved information accurate and relevant?
-3. **Ethical Considerations:** Are there clear guidelines and warnings about the ethical and legal use of the tool?
-4. **Usability:** Is the tool user-friendly and well-documented?
+```sh
+$> image-inspector -s -o hidden_data4.txt image-example4.jpeg
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+xo0EZuWA9AE<...>
+=/1dE
+-----END PGP PUBLIC KEY BLOCK-----
+$>
+```
-###### Did the tool design and implementation align with all the project requirements above?
+> The results are cut. you can compare the beginning and the end of the results!
-###### Were the students able to implement a functional and reliable tool that meets the project requirements?
+###### Does the tool produce accurate and expected results for different images?
#### Bonus
diff --git a/subjects/devops/serverless/README.md b/subjects/devops/serverless/README.md
new file mode 100644
index 000000000..e7f06408e
--- /dev/null
+++ b/subjects/devops/serverless/README.md
@@ -0,0 +1,159 @@
+## Serverless Payments Reminder
+
+Serverless Payments Reminder is a basic Slack Bot that reminds companies / users to pay their bills. The reminder gets triggered by AWS EventBridge (also known as CloudWatch Events). The bot itself is hosted on a simple AWS Lambda function.
+
+### Requirements for the task
+
+Create a simple Slack bot using:
+
+- [AWS](https://aws.amazon.com/)
+- [Serverless Framework](https://serverless.com/)
+- [Cloudformation](https://aws.amazon.com/cloudformation/)
+- [Terraform](https://www.terraform.io/)
+
+### Task
+
+The task is separated into multiple different levels. The levels are ordered by complexity. You can choose the level that you feel most comfortable with.
+
+## Level 0: Basic Lambda Function hosted via Serverless
+
+**1. Create Slack Bot**
+
+Write a slack bot, that sends a reminder to slack channel with the following message:
+
+```sh
+Dear Board Members! This is a reminder to make the payment for the licenses of the software. The due date is 07.XX.YY, where XX is the month and YY is the year. The amount to be paid is $ZZZ.VV. Please make the payment as soon as possible to . Thank you!
+```
+
+The environment variables which must be available in the Lambda function are:
+
+- `SLACK_WEBHOOK_URL` - The Slack Webhook URL
+- `AMOUNT` - The amount to be paid
+- `IBAN_NUMBER` - The IBAN number
+
+The due date must be calculated based on the current date for the next month.
+
+Before step two, you need to test that Slack Bot is functioning properly by running an application locally. It should send a message to the Slack channel.
+
+**2. Write tests for the application**
+
+Write integration tests for the application to ensure that each part of the application is functioning properly.
+
+**3. Use [Serverless Framework](https://github.com/serverless/serverless) to host the lambda function**
+
+Serverless framework is an automation tool used to deploy serverless applications which can help with event-driven architecture deployments.
+
+Use the serverless framework to host the lambda function combined with AWS Eventbridge.
+
+**Refs**
+
+- [AWS EventBridge](https://www.serverless.com/framework/docs/providers/aws/events/event-bridge)
+- [AWS Lambda Function](https://www.serverless.com/framework/docs/providers/aws/guide/functions).
+
+AWS Eventbridge should trigger lambda function every month on the 1st day of the month at 10:00 AM.
+
+**Note** Before hosting, you need to ensure that the bot is written in a way that it can be hosted on AWS Lambda. You can look at the example [here](https://github.com/KostLinux/aws-incident-manager-notifier/blob/56d52e90f8a14e689e7d2a1c7ee44590de5af2f5/main.go#L158).
+
+## Level 1: Basic Lambda Function automation via Cloudformation
+
+**1. Repeat the 1st and 2nd step from Level 0**
+
+Create a slack bot, that sends a reminder to slack channel. Write integration tests for the application to ensure that each part of the application is functioning properly.
+
+**Note** Don't forget to add Lambda handler for the application
+
+**2. Use [Cloudformation](https://aws.amazon.com/cloudformation/) to host the lambda function**
+
+Cloudformation is Infrastructure As Code (IaC) tool used to automate the provisioning of AWS resources inside the AWS. It allows you to use a simple yaml syntax to define the resources you want to create.
+
+**2.1 Hosting the Lambda function**
+
+Write cloudformation template with parameters (variables) `SlackWebhookUrl`, `Amount`, `IbanNumber`. The template should automatically provision the Slackbot based on architecture mentioned in Level 0 step 3.
+
+## Level 2: Basic Lambda Function automation via Basic Terraform with Local State
+
+Terraform is an Infrastructure As Code (IaC) tool used to automate the provisioning of resources inside different SaaS solutions and Cloud providers. It uses HCL syntax, which is easy maintainable. The main problem of terraform is that you need to know, how everything works under the hood (e.g. IAM roles, policies, serverless platforms etc).
+
+**1. Repeat the 1st and 2nd step from Level 0**
+
+Create a slack bot, that sends a reminder to slack channel. Write integration tests for the application to ensure that each part of the application is functioning properly.
+
+**Note** Don't forget to add Lambda handler for the application
+
+**2. Automate the hosting via Terraform**
+
+**2.1 Write an IAM role with the least privilege principle for the lambda function and EventBridge.**
+
+**2.2 Automatically pack up the lambda function into a zip file**
+
+**2.3 Build the lambda function based on the zip file**
+
+**2.4 Build AWS Eventbridge, which will trigger the lambda function**
+
+**Note** Lambda function should be triggered every month on the 1st day of the month at 10:00 AM.
+
+At this level you can use local state for terraform, no modules needed to write.
+
+## Level 3: Basic Lambda Function automation via Terraform Module with Remote S3 State (advanced)
+
+In a DevOps world, mostly we use remote state for terraform. The main reason is that we can share the state with other team members and we can easily manage the state of the infrastructure. Although it is a bit more complex to set up, it allows you to avoid issues when someone even removes the state file, cause S3 has versioning turned on.
+
+This level is more advanced, but more near to the real-world scenario. As a DevOps Engineer / SRE mostly all the terraform code is written in modules (or using community pre-built modules). Modules help us to maintain the codebase and reuse the code in different projects, so you don't need to write the same code again and again.
+
+**1. Repeat the steps from Level 2**
+
+Repeat all the steps from Level 2, but now you need to write a terraform module for the lambda function and EventBridge. Which means that instead of writing values directly into main.tf file, everything should be written using variables. For example:
+
+```tf
+resource "aws_lambda_function" "slack_bot" {
+ function_name = var.function_name
+ role = var.role
+ handler = var.handler
+ runtime = var.runtime
+ timeout = var.timeout
+}
+```
+
+We're using variables for each value, so we can reuse the module in different projects.
+
+**2. Use remote state for terraform**
+
+In this step you need to configure IAM User with least privilege principle for terraform to access S3 bucket, provision resources in Eventbridge and Lambda function.
+
+**Note** We would recommend using [Cloudformation](https://aws.amazon.com/cloudformation/) to create an IAM User with the least privilege principle + S3 Bucket for the remote state. Cloudformation can be applied via AWS CLI which means that everything persists to be AS CODE.
+
+**3. Use the S3 bucket for the remote state and module to provision the resources**
+
+Write your backend configuration to backend.tf file:
+
+```tf
+terraform {
+ backend "s3" {
+ bucket = ""
+ key = ""
+ region = ""
+ encrypt = ""
+ }
+}
+```
+
+Use the module written at step 1 to provision the resources
+
+```tf
+module "slack_bot" {
+ source = "./modules/slack_bot"
+ function_name = "slack_bot"
+ role = "arn:aws:iam::123456789012:role/lambda-role"
+ handler = "main.handler"
+ runtime = "nodejs14.x"
+ timeout = 10
+}
+```
+
+## Helpful commands
+
+- `serverless deploy` - Deploy the serverless application
+- `aws cloudformation deploy --template-file template.yaml --stack-name my-stack` - Deploy the cloudformation stack
+- `terraform init` - Initialize the terraform project and remote state.
+- `terraform plan` - Plan the resources you're going to provision. It will show you the changes that will be made.
+- `terraform apply` - Apply the terraform project only if you're sure that everything is correct during the plan.
diff --git a/subjects/devops/serverless/backend.tf b/subjects/devops/serverless/backend.tf
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/devops/serverless/cloudformation/.gitkeep b/subjects/devops/serverless/cloudformation/.gitkeep
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/devops/serverless/main.tf b/subjects/devops/serverless/main.tf
new file mode 100644
index 000000000..45f3691d2
--- /dev/null
+++ b/subjects/devops/serverless/main.tf
@@ -0,0 +1,3 @@
+module "aws_slack_bot" {
+ source = "./modules/aws_slack_bot"
+}
\ No newline at end of file
diff --git a/subjects/devops/serverless/modules/aws_slack_bot/.gitkeep b/subjects/devops/serverless/modules/aws_slack_bot/.gitkeep
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/devops/serverless/modules/aws_slack_bot/bot/.gitkeep b/subjects/devops/serverless/modules/aws_slack_bot/bot/.gitkeep
new file mode 100644
index 000000000..e69de29bb
diff --git a/subjects/gaming/2-5-d-adventure/README.md b/subjects/gaming/2-5-d-adventure/README.md
new file mode 100644
index 000000000..718af1717
--- /dev/null
+++ b/subjects/gaming/2-5-d-adventure/README.md
@@ -0,0 +1,148 @@
+## 2.5D Adventure
+
+### Overview
+
+This project involves creating a simple 2.5D side-scroller game designed to introduce you to the fundamentals of Unreal Engine 5 and game development, without the complexity of advanced mechanics. It focuses on the essential skills and concepts needed to start your journey as a game developer.
+
+
+
+
+
+### Role play
+
+You've just embarked on your journey into game development, choosing `Unreal Engine 5` as your primary tool. Excited by the possibilities, you decide to create a simple 2.5D game as your first project. However, as you dive into the engine, you realize there's a vast array of tools and features you've never encountered before. Now, you're tasked with navigating this uncharted territory, learning new skills in level design, scripting, and asset management to bring your game to life.
+
+### Learning Objective
+
+At the end of this project you will have learned:
+
+- Setting up a basic player character (input handling, movement, camera, etc.)
+- Basic scripting (`Blueprints` and/or `C++`).
+- Collision detection.
+- Object creation and `instancing`.
+- Basic UI/HUD.
+- Basic level design
+- Game logic and flow (Game Loops).
+
+### Instructions
+
+#### General
+
+The use of `event dispatchers` is mandatory throughout the project, any code coupling will be disqualified.
+
+> Tip: look for the observer pattern.
+
+Your game should follow a coherent `theme` of your choice, whether it's a dark fantasy, sci-fi, or something entirely different. Let your imagination guide you.
+
+> Note: the resources section will list some places where you can browse assets.
+
+> Tip: For maximum learning, it is recommended to start this project with a blank Unreal project and implement everything from scratch.
+
+#### Main Menu
+
+The main menu `widget` should:
+
+- Be on a separate `level/map` from the `main game` map.
+- Contain two buttons:
+ - Start game button.
+ - Exit game button.
+
+#### Player Character
+
+The player `character` should:
+
+- Have a skeletal mesh.
+- Move only along two axes: left-right and up-down.
+- Have a basic locomotion system with the following animations:
+ - `Idle`.
+ - `Walking`.
+ - `Running`.
+ - `Jumping`.
+ - `Falling`.
+ - `Landing`.
+- Transition smoothly between a walking and running animations based on their speed.
+
+
+
+
+> Tip: Look into the best practices for creating a locomotion system, Animation blueprints and Blend spaces.
+
+#### Collectible
+
+The collectible `Actor` should:
+
+- Have a static mesh.
+- Rotate around an axis of your choice.
+- Have a box collider that acts like a trigger.
+- Be collected when the player enters its box trigger.
+- Play a sound when collected
+
+
+
+
+#### HUD
+
+The HUD `widget` should:
+
+- Display a value related to the `collectible`.
+- Be updated each time a `collectible` is picked up.
+
+
+
+
+#### Enemy
+
+The enemy `character` should:
+
+- Have a skeletal mesh.
+- Have at least a walking cycle.
+- Have a simple AI that patrols between two set points.
+- Kill the player on collision.
+- Be killed if the player lands on top of it.
+- Play a sound when killed.
+- create an instance of `Collectible` at the place of death.
+ > Note: Make sure the instance of collectible spawned from killing an enemy also updates the HUD.
+
+
+
+
+
+
+
+
+#### Game Loop Logic
+
+The game loop consists of a spawn point where the player `starts` and `respawns` when dead.
+And an end point that defines the player goal to finish the level.
+When the player reaches the end point:
+
+- a menu with options to `restart` or `quit` the game should be displayed.
+
+#### Level design
+
+Your level design shouldn't consist of just a long, empty run to the finish point. However, since creating a level is a creative process, you have the freedom to design it as you see fit. For example, you can include moving platforms or skill-based platforming elements. The choice is yours to provide the player with a fun and challenging experience.
+
+> Tip: look at other games from a similar genre for inspiration.
+>
+
+
+
+### Bonus
+
+- Add a health system to both the player character and the enemy character. (look into `Components`)
+- Add a simple crouch to your locomotion system.
+- more mechanics as you see fit for your game.
+- Create a simple `Game Design Document` where you describe your mechanics and how are you planning to implement them.
+
+### Submission
+
+- In your repository there should be a zip file of a build of your game for your target platform.
+ > If it is not possible to upload files to Gitea due to their size, use GitHub instead and have a look at [Git LSF](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)
+
+### Resources
+
+- [Animation Blueprints](https://dev.epicgames.com/documentation/en-us/unreal-engine/animation-blueprints-in-unreal-engine)
+- [Actor Components](https://dev.epicgames.com/documentation/en-us/unreal-engine/components-in-unreal-engine)
+- [Mixamo for animations and character models](https://www.mixamo.com/)
+- [SketchFab for 3D models](https://sketchfab.com/)
+- [itch.io for more assets](https://itch.io/)
diff --git a/subjects/gaming/2-5-d-adventure/audit/README.md b/subjects/gaming/2-5-d-adventure/audit/README.md
new file mode 100644
index 000000000..c370d859d
--- /dev/null
+++ b/subjects/gaming/2-5-d-adventure/audit/README.md
@@ -0,0 +1,89 @@
+> Due to file size reason, the solution might be uploaded on GitHub instead of Gitea!
+
+#### General
+
+##### If, at any point during the audit, coupled code is detected that could have been resolved using the Observer pattern (`event dispatchers`), the audit will stop, and the student will fail the project.
+
+###### Is the game following a coherent theme ?
+
+#### Main Menu
+
+###### Is the main menu widget on a separate level/map from the main game map?
+
+###### Does the main menu contain a Start game button?
+
+###### Does the main menu contain an Exit game button?
+
+#### Player Character
+
+###### Does the player character have a skeletal mesh?
+
+###### Can the player character move only along two axes: left-right and up-down?
+
+###### Does the player character have a basic locomotion system with all the required animations?
+
+###### Does the player character transition smoothly between walking and running animations based on their speed?
+
+#### Collectible
+
+###### Does the collectible Actor have a static mesh?
+
+###### Does the collectible rotate around an axis?
+
+###### Does the collectible have a box collider that acts as a trigger?
+
+###### Is the collectible collected when the player enters its box trigger?
+
+###### Does the collectible play a sound when collected?
+
+#### HUD
+
+###### Does the HUD widget display a value related to the `collectible`?
+
+###### Is the HUD updated each time a `collectible` is picked up?
+
+###### Is the HUD also updated when picking a `collectible` that spawned from killing an enemy?
+
+#### Enemy
+
+###### Does the enemy character have a skeletal mesh?
+
+###### Does the enemy character have at least a walking cycle?
+
+###### Does the enemy character have a simple AI that patrols between two set points?
+
+###### Does the enemy character kill the player on collision?
+
+###### Is the enemy character killed if the player lands on top of it?
+
+###### Does the enemy character play a sound when killed?
+
+###### Does the enemy character create an instance of a `Collectible` at the place of death?
+
+#### Game loop
+
+###### Is there a spawn point where the player starts?
+
+###### Does the player respawn at the spawn point when dead?
+
+###### Is there an end point that defines the player’s goal to finish the level?
+
+###### When the player reaches the end point, is a menu displayed with options to restart or quit the game?
+
+#### Level design
+
+###### Does the level design avoid being just a long, empty run to the finish point?
+
+###### Does the level include mechanics chosen by the student? `(e.g. moving platforms skill-based platforming)`
+
+###### Does the level provide a fun and challenging experience for the player?
+
+#### Bonus
+
+###### +Has a health system been added to both the player character and the enemy character using Components?
+
+###### +Has a simple crouch been added to the player character's locomotion system?
+
+###### +Have additional mechanics been implemented to fit the overall game design?
+
+###### +Has a simple Game Design Document been created that describes the mechanics and outlines the plan for implementing them?
diff --git a/subjects/gaming/2-5-d-adventure/resources/1.jpg b/subjects/gaming/2-5-d-adventure/resources/1.jpg
new file mode 100755
index 000000000..4222cc2e3
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/1.jpg differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/collectible.gif b/subjects/gaming/2-5-d-adventure/resources/collectible.gif
new file mode 100755
index 000000000..dbf91d293
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/collectible.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/enemydie.gif b/subjects/gaming/2-5-d-adventure/resources/enemydie.gif
new file mode 100755
index 000000000..62ec093dc
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/enemydie.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif b/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif
new file mode 100755
index 000000000..dedd1cb95
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/hud.gif b/subjects/gaming/2-5-d-adventure/resources/hud.gif
new file mode 100755
index 000000000..904d0cdfc
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/hud.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/locomotion.gif b/subjects/gaming/2-5-d-adventure/resources/locomotion.gif
new file mode 100755
index 000000000..b8de0e007
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/locomotion.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/platformer.jpg b/subjects/gaming/2-5-d-adventure/resources/platformer.jpg
new file mode 100755
index 000000000..52c4ff8e9
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/platformer.jpg differ
diff --git a/subjects/gaming/firing-range/README.md b/subjects/gaming/firing-range/README.md
index 4775ebc60..6fdd1c1f1 100644
--- a/subjects/gaming/firing-range/README.md
+++ b/subjects/gaming/firing-range/README.md
@@ -1,39 +1,125 @@
-## FiringRange
+## Firing-range
-In this exercise, you will learn to use the Unreal Engine and Blueprints to script functionalities of a basic FPS game. The theme is to reproduce a firing range. And remember, weapons are allowed only inside the shooting area!!
+### Overview
+
+This project involves creating a fully functional firing range in Unreal Engine 5 (UE5). You will focus on implementing shooting mechanics, a weapon system, player input handling, physics for projectiles, and basic AI to control moving targets. Your task is to build a simple environment where the player can shoot targets, and all systems should work seamlessly together.
+
+
+
+
+
+### Role Play
+
+You are developing a firing range training level for a first-person shooter game. You are required to set up a working shooting system, integrate a functional weapon with reload mechanics, implement a physics system for projectiles, and design basic AI for moving targets. Additionally, you will create a player HUD that tracks their score, accuracy, and remaining ammunition.
+
+### Learning Objective
+
+By the end of this project, you will have implemented:
+
+- A complete shooting mechanic (with accurate aiming, projectiles, and hit detection).
+- A weapon system with at least one firearm, including shooting and reload mechanics.
+- Basic AI to control target movement.
+- Physics-based projectiles that interact with the environment.
+- A simple UI displaying relevant gameplay information (accuracy, ammo count, etc.).
+- A simple firing range level design that incorporates moving and stationary targets.
### Instructions
-The map of this project should be composed of a cube with dimensions of X = 35, Y = 40, Z = 1. It should simulate the floor and other cubes as walls around the floor. In the map there should be a zone where the character is able to walk around and shoot the targets and another zone where the player can not go and where the targets are present.
+#### General Requirements
+
+- Use `Blueprints` or `C++` to implement the game mechanics.
+- Implement a firing system where the player can aim downsights and shoot.
+- Implement a weapon system that supports shooting, reloading, and proper hit detection.
+- Create a firing range level that includes both stationary and moving targets.
+- Implement a physics system that governs projectile behavior (trajectory and collisions).
+- Implement a HUD that shows the player's score, accuracy, and remaining ammunition.
+
+#### Main Menu
+
+The game's main menu must:
+
+- Be a separate `level/map`.
+- Include the following options:
+ - **Start Game**: Transitions to the firing range gameplay.
+ - **Settings**: Allows the player to adjust mouse sensitivity.
+ - **Quit**: Closes the game.
+
+#### Game Screen (HUD)
+
+The game screen must include a HUD that displays:
+
+- A precise crosshair that accurately indicates the bullet's point of impact.
+- The player's current accuracy (hits devided by total shots fired).
+- Remaining ammunition and reload status for the current weapon.
+
+#### Player Character
+
+The player character must have the following functionalities:
+
+- Basic movement around the firing range.
+- Proper input handling for aiming, shooting, and reloading.
+- Interact with ammo pickups to replenish ammo.
+
+#### Weapons
+
+You must create at least one firearm (e.g., a pistol) that includes:
+
+- Recoil mechanics.
+- Reloading the weapon with an appropriate animation.
+- Projectile physics that simulate bullet trajectories.
+- Bullet hit detection (with an effect on impact, e.g., sound and visual feedback).
+
+#### Targets and AI
+
+You must implement the following for the targets:
+
+- Create a stationary target.
+- Create a moving target with basic AI that follows a predefined path or pattern.
+- Implement hit detection for the targets.
+- Ensure the targets respawn after a set interval once they are hit.
+
+
+
+
+
+
-For this project you will have to create a Blueprint Class target, that will have some of these characteristics. The target should :
+#### Game Loop Logic
-- have associated to it the previous created material.
-- either be moving from side to side or be stationary.
-- be dynamic, using the timeline node.
-- use a public variable to set or unset the movement animation of the target.
-- rise again after x seconds after being hit it with a projectile, and behave like before it was hit.
+The game loop must be continuous and consist of:
-Only one class of target is allowed for the whole project.
+- The player starts with a loaded weapon and can shoot at targets.
+- The player can open a pause menu at any time, with options to:
+ - Restart the game (reset score, targets, and ammo).
+ - Return to the main menu.
-The previously mentioned projectile should:
+#### Level Design
-- have a size of X = Y = Z = 0,5.
-- have a speed of 10000.
+You must design a firing range that includes:
-After downloading and unzipping this [file](https://assets.01-edu.org/Unreal-Engine-Piscine/FiringRange.zip), you can copy its content to your project Content folder.
+- A coherent theme to ensure a consistent and immersive experience.
+- Proper lighting and environment setup to ensure the range is clear and visually appealing.
+- A section with stationary targets.
+- A section with moving targets.
+- Ammo pickups where the player can restock.
-When finished, your project should look like the executable example on the folder or the ["Expected Result" video](https://youtu.be/EBibaN-dh_0).
+### Bonus
-> Do not forget to zip up the project compile and save everything for peer correction.
-> If it is not possible to upload files to Gitea due to their size, use GitHub instead and have a look at [Git LSF](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)
+- Add multiple weapons (e.g., a shotgun, sniper rifle) with unique shooting and reload mechanics.
+- Implement more advanced target AI, such as random movement patterns or different difficulty levels.
+- Add different hit zones for targets, with headshots awarding more accuracy points.
+- Design a timed challenge mode where the player must hit all targets within a set time frame.
-#### Bonus
+### Submission
-Here are some ideas for improving the game:
+- You must upload a zip file of your game build in your repository.
+ - Ensure that the build works on your platform.
+ - If file size is an issue, use GitHub with [Git LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github).
-- Targets with different speeds.
-- Textures on the walls and ground.
-- Adding obstacles in front of the targets.
+### Resources
-[Here](https://www.youtube.com/playlist?list=PLHyAJ_GrRtf9sxZqgfPVM06PrLk8_CWA-) you can find an instructional playlist on Unreal Engine.
+- [Unreal Engine's AI Documentation](https://dev.epicgames.com/documentation/en-us/unreal-engine/ai-system-settings-in-the-unreal-engine-project-settings?application_version=5.5)
+- [Projectile Movement Component](https://dev.epicgames.com/documentation/en-us/unreal-engine/BlueprintAPI/Game/Components/ProjectileMovement?application_version=5.5)
+- [Mixamo for character animations and models](https://www.mixamo.com/)
+- [SketchFab for 3D models](https://sketchfab.com/)
+- [itch.io for additional assets](https://itch.io/)
diff --git a/subjects/gaming/firing-range/audit/README.md b/subjects/gaming/firing-range/audit/README.md
index 871c9a15c..f3bbd49b7 100644
--- a/subjects/gaming/firing-range/audit/README.md
+++ b/subjects/gaming/firing-range/audit/README.md
@@ -1,27 +1,79 @@
> Due to file size reason, the solution might be uploaded on GitHub instead of Gitea!
-#### Functional
+#### Main menu
-###### Are the map size (X = 35, Y = 40, Z = 1) and composition (using cubes) being respected?
+###### Is the main menu widget on a separate level/map?
-###### Are the projectile size (X = Y = Z = 0,5) and speed (10000) being respected?
+###### Does the main menu contain a Start Game button that transitions to the firing range gameplay?
-###### If you try to move the target to the target zone, is the player forbidden from trespassing to that zone by an invisible wall?
+###### Does the main menu contain a Settings button for adjusting mouse sensitivity?
-###### When you shoot a target, does the bullet go through the invisible wall?
+###### Does the main menu contain an Exit Game button?
-###### Did the targets correctly lay on the floor when hit by the projectile?
+#### HUD
-###### Did the target rotate from the bottom and not from the center?
+###### Does the HUD display an accurate crosshair that indicates the bullet's point of impact?
-###### Is there only one class “BP_Target” present on the project?
+###### Does the HUD display the player's accuracy?
-###### Do all the public variables have a tooltip? (Mouse over it to check if a description is set or check if the variable have a little green eye on the right)
+###### Does the HUD display the remaining ammunition and the reload status?
+
+#### Player Character
+
+###### Can the player character move around the firing range?
+
+###### Is input handling for aiming, shooting, and reloading functional?
+
+###### Can the player interact with ammo pickups to replenish ammunition?
+
+#### Weapons
+
+###### Does the weapon have recoil mechanics implemented?
+
+###### Can the weapon be reloaded and has a proper reloading animation?
+
+###### Are projectile physics implemented for bullets, simulating accurate bullet trajectories?
+
+###### Is hit detection for bullets functional, with audio and visual feedback upon impact?
+
+#### Targets and AI
+
+###### Is there a stationary target present in the firing range?
+
+###### Is there a moving target with basic AI that follows a predefined path or pattern?
+
+###### Is hit detection implemented for both stationary and moving targets?
+
+###### Do the targets respawn after being hit, within a set interval?
+
+#### Level Design
+
+###### Does the firing range follow a coherent and immersive theme?
+
+###### Is the level lighting and environment properly set up for clarity and appeal?
+
+###### Does the level include a section with stationary targets?
+
+###### Does the level include a section with moving targets?
+
+###### Are there ammo pickups available for the player to replenish ammunition?
+
+#### Game Loop Logic
+
+###### Does the game loop start with a loaded weapon, ready for the player to shoot?
+
+###### Can the player open a pause menu?
+
+###### Does the pause menu include a restart button (reset score, targets, and ammo)?
+
+###### Does the pause menu include a return to the main menu button?
#### Bonus
-###### +Do different targets have different speeds?
+###### +Have additional weapons (e.g., shotgun, sniper rifle) with unique shooting and reload mechanics been added?
+
+###### +Has more advanced target AI with random movement patterns or difficulty levels been implemented?
-###### +Do the walls and floor have texture?
+###### +Are there hit zones for targets (e.g., headshots) that award more points or accuracy?
-###### +Are there obstacles in front of targets?
+###### +Has a timed challenge mode been added where the player must hit all targets within a set time frame?
diff --git a/subjects/gaming/firing-range/resources/example1.jpg b/subjects/gaming/firing-range/resources/example1.jpg
new file mode 100755
index 000000000..3f99487ca
Binary files /dev/null and b/subjects/gaming/firing-range/resources/example1.jpg differ
diff --git a/subjects/gaming/firing-range/resources/example2.jpg b/subjects/gaming/firing-range/resources/example2.jpg
new file mode 100755
index 000000000..2285b1666
Binary files /dev/null and b/subjects/gaming/firing-range/resources/example2.jpg differ
diff --git a/subjects/gaming/firing-range/resources/fgm.jpg b/subjects/gaming/firing-range/resources/fgm.jpg
new file mode 100755
index 000000000..c6604989e
Binary files /dev/null and b/subjects/gaming/firing-range/resources/fgm.jpg differ
diff --git a/subjects/its-a-match/README.md b/subjects/its-a-match/README.md
index cc67b3169..61e585c1a 100644
--- a/subjects/its-a-match/README.md
+++ b/subjects/its-a-match/README.md
@@ -2,7 +2,7 @@
### Instructions
-Have you been been pondering over the etymology of `grep`?
+Have you been pondering over the etymology of `grep`?
Create 4 regular expression variables:
diff --git a/subjects/java/checkpoints/distinct-substring-lenght/ExerciseRunner.java b/subjects/java/checkpoints/distinct-substring-length/ExerciseRunner.java
similarity index 100%
rename from subjects/java/checkpoints/distinct-substring-lenght/ExerciseRunner.java
rename to subjects/java/checkpoints/distinct-substring-length/ExerciseRunner.java
diff --git a/subjects/java/checkpoints/distinct-substring-lenght/README.md b/subjects/java/checkpoints/distinct-substring-length/README.md
similarity index 100%
rename from subjects/java/checkpoints/distinct-substring-lenght/README.md
rename to subjects/java/checkpoints/distinct-substring-length/README.md
diff --git a/subjects/quad/audit/README.md b/subjects/quad/audit/README.md
index b60f03e65..22983a916 100644
--- a/subjects/quad/audit/README.md
+++ b/subjects/quad/audit/README.md
@@ -1,6 +1,6 @@
#### quadA
-> ***NOTE: If you are an admin and you want to test this project, follow the instructions [in the this subject](https://github.com/01-edu/go-tests/blob/master/raid-testing.md) before you proceed to the questions.***
+> **_NOTE: If you are an admin and you want to test this project, follow the instructions [in the this subject](https://github.com/01-edu/go-tests/blob/master/raid-testing.md) before you proceed to the questions._**
##### Open the repository of the project and check the submitted files
@@ -14,7 +14,7 @@ o---o
o---o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -22,7 +22,7 @@ o---o
o---o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -30,7 +30,7 @@ o---o
o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -42,19 +42,19 @@ o
o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=20 and y=1"`
@@ -62,7 +62,7 @@ o
o------------------o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=10 and y=8"`
@@ -77,7 +77,7 @@ o--------o
o--------o
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadB
@@ -89,7 +89,7 @@ o--------o
\***/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -97,7 +97,7 @@ o--------o
/***\
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -105,7 +105,7 @@ o--------o
/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -117,19 +117,19 @@ o--------o
\
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=18 and y=6"`
@@ -142,7 +142,7 @@ o--------o
\****************/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=9 and y=3"`
@@ -152,7 +152,7 @@ o--------o
\*******/
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadC
@@ -164,7 +164,7 @@ B B
CBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -172,7 +172,7 @@ CBBBC
ABBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -180,7 +180,7 @@ ABBBA
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -192,19 +192,19 @@ B
C
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=13 and y=7"`
@@ -218,7 +218,7 @@ B B
CBBBBBBBBBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=10 and y=15"`
@@ -240,7 +240,7 @@ B B
CBBBBBBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadD
@@ -252,7 +252,7 @@ B B
ABBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -260,7 +260,7 @@ ABBBC
ABBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -268,7 +268,7 @@ ABBBC
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -280,19 +280,19 @@ B
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=3 and y=16"`
@@ -315,7 +315,7 @@ B B
ABC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=7 and y=16"`
@@ -338,7 +338,7 @@ B B
ABBBBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
#### quadE
@@ -350,7 +350,7 @@ B B
CBBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=5 and y=1"`
@@ -358,7 +358,7 @@ CBBBA
ABBBC
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=1"`
@@ -366,7 +366,7 @@ ABBBC
A
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=1 and y=5"`
@@ -378,19 +378,19 @@ B
C
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=0 and y=0"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=-1 and y=6"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=6 and y=-1"`
-###### Does the function returns nothing?
+###### Does the function return nothing?
##### Try running the function with the arguments: `"x=21 and y=24"`
@@ -422,7 +422,7 @@ CBBBBBBBBBBBBBBBBBBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
##### Try running the function with the arguments: `"x=18 and y=8"`
@@ -438,4 +438,4 @@ CBBBBBBBBBBBBBBBBA
```
-###### Does the function returns the value above?
+###### Does the function return the output shown above?
diff --git a/subjects/user-experience/piscine-ui/atomic-design/README.md b/subjects/user-experience/piscine-ui/atomic-design/README.md
index 5e5a642db..7157c9c51 100644
--- a/subjects/user-experience/piscine-ui/atomic-design/README.md
+++ b/subjects/user-experience/piscine-ui/atomic-design/README.md
@@ -1,4 +1,4 @@
-## Browsing
+### Browsing
**Context:**
@@ -48,7 +48,7 @@ Don't forget to:
- User Interface Design is a hybrid role and can bring together concepts from interaction design, visual design, information architecture and even Front End Development.
-## Material Design
+### Material Design
### Instructions
@@ -74,7 +74,7 @@ Don't forget to:
- [Material Design Awards 2019](https://design.google/library/material-design-awards-2019/)
- [What is Material Design - Wikipedia](https://en.wikipedia.org/wiki/Material_Design)
-## Design system library
+### Design system library
### Instructions
@@ -103,7 +103,7 @@ Don't forget to:
- [Atomic Design Methodology](https://atomicdesign.bradfrost.com/chapter-2/)
-## Library for climbing addicts
+### Library for climbing addicts
### Instructions
@@ -145,7 +145,7 @@ Don't forget to:
- [Building a design system library - Lyft](https://medium.com/tap-to-dismiss/building-a-design-system-library-532ef2492811)
- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
-## Library for a dating app
+### Library for a dating app
### Instructions
@@ -185,4 +185,4 @@ Don't forget to:
- [Introduction to design systems](https://www.youtube.com/watch?v=xEuBCUngJ_U)
- [Create a design system - Figma course](https://www.youtube.com/watch?v=RYDiDpW2VkM)
- [Building a design system library - Lyft](https://medium.com/tap-to-dismiss/building-a-design-system-library-532ef2492811)
-- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
\ No newline at end of file
+- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
diff --git a/subjects/user-experience/piscine-ui/building-an-interface/README.md b/subjects/user-experience/piscine-ui/building-an-interface/README.md
index ca292bf0e..cb0d6aedd 100644
--- a/subjects/user-experience/piscine-ui/building-an-interface/README.md
+++ b/subjects/user-experience/piscine-ui/building-an-interface/README.md
@@ -1,4 +1,4 @@
-## Styleguide
+### Styleguide
**Context:**
@@ -47,7 +47,7 @@ Don't forget to:
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
- [Example of a Style Guide in UI](https://www.pinterest.pt/pin/454019206175050454/)
-## Design system library
+### Design system library
### Instructions
@@ -82,7 +82,7 @@ Don't forget to:
- [Building a design system library - Lyft](https://medium.com/tap-to-dismiss/building-a-design-system-library-532ef2492811)
- [Examples of UI Buttons library](https://www.pinterest.co.kr/pin/663014376380850291/)
-## Design screens
+### Design screens
### Instructions
@@ -115,7 +115,7 @@ Don't forget to:
- [Unsplash](https://unsplash.com/) for visuals
-## Animation
+### Animation
### Instructions
@@ -141,9 +141,10 @@ Don't forget to:
**Quote:**
"Speak human: Use the words your users use.’ Dan Saffer | Microinteractions.
+
- [From low-fidelity to high-fidelity](https://mockitt.wondershare.com/prototyping/low-fidelity-vs-high-fidelity.html)
-## Desirability testing
+### Desirability testing
### Instructions
@@ -181,4 +182,4 @@ Don't forget to:
**Quote:**
-- "Interaction design focuses on the design of behavior of a person’s interaction with a digital interface. It is also concerned with satisfying the needs and desires of the people who will interact with a product or service.’ Alan Cooper, About Face: The Essentials of Interaction Design
\ No newline at end of file
+- "Interaction design focuses on the design of behavior of a person’s interaction with a digital interface. It is also concerned with satisfying the needs and desires of the people who will interact with a product or service.’ Alan Cooper, About Face: The Essentials of Interaction Design
diff --git a/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md b/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md
index 9fdd95f39..2e69635c7 100644
--- a/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md
+++ b/subjects/user-experience/piscine-ui/colors-and-moodboard/README.md
@@ -1,4 +1,4 @@
-## Find the colors
+### Find the colors
**Context:**
@@ -38,7 +38,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## Color codes
+### Color codes
### Instructions
@@ -72,7 +72,7 @@ Don't forget to :
- [https://brave.com/es/](https://brave.com/es/)
- [https://www.ted.com/](https://www.ted.com/)
-## Color combinations
+### Color combinations
### Instructions
@@ -151,7 +151,7 @@ Don't forget to:
- [https://calendar.google.com/](https://calendar.google.com/)
- [https://www.ebay.com/](https://www.ebay.com/)
-## Moodboard
+### Moodboard
### Instructions
@@ -185,7 +185,7 @@ Don't forget to:
- [Example3](https://i.pinimg.com/564x/ee/9d/d6/ee9dd6fbb82b0e5b4dd2924580b765dd.jpg)
- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Typography
+### Typography
### Instructions
@@ -226,7 +226,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## Typography moodboard
+### Typography moodboard
### Instructions
@@ -268,7 +268,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## UI Challenge - Timer
+### UI Challenge - Timer
### Instructions
@@ -298,7 +298,7 @@ Don't forget to:
- The frame is Android 360 x 640px.
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Watches
+### UI Challenge - Watches
### Instructions
@@ -332,7 +332,7 @@ Don't forget to:
- You can use existing Libraries by browsing the Figma community resources.
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Flight
+### UI Challenge - Flight
### Instructions
@@ -362,7 +362,7 @@ Don't forget to:
- [Figma article about Symbols and Variants](https://help.figma.com/hc/en-us/articles/360056440594-Create-and-use-variants).
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Spotify
+### UI Challenge - Spotify
### Instructions
@@ -394,7 +394,7 @@ Don't forget to:
- [Figma article about Symbols and Variants](https://help.figma.com/hc/en-us/articles/360056440594-Create-and-use-variants).
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## UI Challenge - Bitcoin Dashboard
+### UI Challenge - Bitcoin Dashboard
### Instructions
diff --git a/subjects/user-experience/piscine-ui/heuristics/README.md b/subjects/user-experience/piscine-ui/heuristics/README.md
index a6f2688da..64cc5f5ba 100644
--- a/subjects/user-experience/piscine-ui/heuristics/README.md
+++ b/subjects/user-experience/piscine-ui/heuristics/README.md
@@ -1,4 +1,4 @@
-## Audit
+### Audit
**Context:**
@@ -49,7 +49,7 @@ Don't forget to:
- [A new usability heuristic evaluation checklist](https://uxplanet.org/a-new-usability-heuristic-evaluation-checklist-259f588da308)
- [Tool : Heuristic evaluation checklist](https://drive.google.com/file/d/10KbfbNZA1oVS1sXbjjXLPPmdZ6nqVkdc/view)
-## Recommendations
+### Recommendations
### Instructions
diff --git a/subjects/user-experience/piscine-ui/rules/README.md b/subjects/user-experience/piscine-ui/rules/README.md
index dc05ffa8c..7556c1559 100644
--- a/subjects/user-experience/piscine-ui/rules/README.md
+++ b/subjects/user-experience/piscine-ui/rules/README.md
@@ -1,4 +1,4 @@
-## Grids
+### Grids
**Context:**
@@ -37,7 +37,7 @@ Don't forget to:
- [Beginning graphic design](https://edu.gcfglobal.org/en/beginning-graphic-design/)
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
-## Multi state
+### Multi state
### Instructions
@@ -67,7 +67,7 @@ Don't forget to:
- [Gareth graphic studio](https://www.youtube.com/c/GarethDavidStudio)
- [Example here with Nintendo.com](https://www.figma.com/file/ahSnWRZeKBO62oJDiXltxY/UI-III---Ex-2) (The screenshots date back to nov 2021. They may differ from the current version of [Nintendo.com](http://Nintendo.com) but the rules are the same).
-## Accessibility (website)
+### Accessibility (website)
### Instructions
@@ -106,7 +106,7 @@ Don't forget to:
- Error states.
- etc.
-## Accessibility (app)
+### Accessibility (app)
### Instructions
@@ -144,7 +144,7 @@ Don't forget to:
- Error states
- etc.
-## Breadcrumbs
+### Breadcrumbs
### Instructions
@@ -167,7 +167,7 @@ Don't forget to:
- [What are breadcrumbs?](https://www.seoptimer.com/blog/breadcrumbs-website/)
-## Toggle buttons
+### Toggle buttons
### Instructions
@@ -190,7 +190,7 @@ Don't forget to:
- [Toggle Switch - Tips](https://uxplanet.org/toggle-switch-5-simple-design-tips-for-better-design-b4046eff4a2f)
-## Radio buttons
+### Radio buttons
### Instructions
@@ -213,7 +213,7 @@ Don't forget to:
- [What is a radio button?](https://www.justinmind.com/blog/radio-button-design-examples/)
-## Calendars
+### Calendars
### Instructions
@@ -232,7 +232,7 @@ Don't forget to:
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Time pickers
+### Time pickers
### Instructions
@@ -251,7 +251,7 @@ Don't forget to:
- Pay attention to the global aspect of the file. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Micro-interactions
+### Micro-interactions
### Instructions
@@ -282,7 +282,7 @@ Don't forget to:
- [Why use micro-interactions in your design](https://hike.one/update/why-use-micro-animations-in-your-design)
- [Micro-interactions: why, when, and how to use them to boost the UX](https://uxdesign.cc/micro-interactions-why-when-and-how-to-use-them-to-boost-the-ux-17094b3baaa0)
-## Consistency
+### Consistency
### Instructions
diff --git a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md
index 6f399c023..4384e64b6 100644
--- a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md
+++ b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/README.md
@@ -1,4 +1,4 @@
-## User Interviews
+### User Interviews
**Context:**
@@ -86,7 +86,7 @@ Thank you so much for your time!
I have a last favor to ask you: is there anyone you know who runs frequently and would be available for a talk?
-## Analytics
+### Analytics
### Instructions
@@ -125,7 +125,7 @@ Examples of insights you can extract from the articles:
Always base your decisions on the data, not on your biases.
-## Personas
+### Personas
### Instructions
@@ -165,7 +165,7 @@ Use the material you got from the exercise `User interview` to build the pierre
"Focus unswervingly, on the customer’ Jesse Hertzberg | Former COO of Squarespace
-## User Journey
+### User Journey
### Instructions
@@ -209,7 +209,7 @@ Most articles you'll find will be about user journeys or customer journeys. Keep
'It’s about catching customers in the act, and providing highly relevant and highly contextual information’ Paul Maritz | CEO Pivotal
-## Problem Statement
+### Problem Statement
### Instructions
@@ -257,7 +257,7 @@ Based on the insights from the exercises `analytics` and `user interviews`, comm
“If I had an hour to solve a problem, I’d spend 55 minutes thinking about the problem and 5 minutes thinking about solutions.” Albert Einstein
-## Ideation
+### Ideation
_You can replace Pierre with your own persona._
@@ -330,7 +330,7 @@ Don't forget to:
Chances are that... If you have gone through all possible solutions, you’ve found the good one.
-## Prototyping
+### Prototyping
### Instructions
diff --git a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md
index 19ec07314..a4e64eee6 100644
--- a/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md
+++ b/subjects/user-experience/piscine-ux/athlete-keep-hydrated/audit/README.md
@@ -1,4 +1,4 @@
-### User interview
+#### User interview
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -12,7 +12,7 @@
###### Does each insight have the name of the person(s) who said it?
-### Analytics
+#### Analytics
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -28,7 +28,7 @@
###### Are the insights different from the ones given in the instructions as an example?
-### Personas
+#### Personas
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -54,7 +54,7 @@
###### Are the insights from ex 1 included in Pierre's persona card?
-### User Journey
+#### User Journey
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -76,7 +76,7 @@
###### For every thought, is there a main emotion?
-### Problem Statement
+#### Problem Statement
###### Is the deliverable labeled as “Name_FirstName_DeliverableName_Date_VersionNumber”?
@@ -92,7 +92,7 @@
##### Is the problem statement broad enough (check the readme tips to understand broad)?
-### Ideation
+#### Ideation
###### Is there a zip folder?
@@ -108,7 +108,7 @@
###### Is there one main idea to solve the problem?
-### Prototyping
+#### Prototyping
###### Is there a zip folder?
diff --git a/subjects/user-experience/piscine-ux/going-on-holidays/README.md b/subjects/user-experience/piscine-ux/going-on-holidays/README.md
index 2cf3787dd..4d7357128 100644
--- a/subjects/user-experience/piscine-ux/going-on-holidays/README.md
+++ b/subjects/user-experience/piscine-ux/going-on-holidays/README.md
@@ -1,4 +1,4 @@
-## Interview guide
+### Interview guide
**Context:**
@@ -46,7 +46,7 @@ Here are the recommended steps :
“To ask open-ended questions is the best approach, but it’s easy to get into the weeds in data analysis when every answer is a paragraph or two of prose. Users quickly tire of answering many open-ended questions, which usually require a lot of typing and explanation.” Norman Nielsen Group
-## Run interviews
+### Run interviews
### Instructions
@@ -68,7 +68,7 @@ Then, write down the script on a written document, and give elements of context
- Pay attention to the global aspect of the document. It must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Affinity diagram & Empathy map
+### Affinity diagram & Empathy map
### Instructions
@@ -108,7 +108,7 @@ Don't forget to:
Remember, you are not the user, so your opinions are not absolute truth.
-## Problem statement
+### Problem statement
### Instructions
@@ -137,7 +137,7 @@ You may use the "How Might We" exercise in pairs.
"Out of clutter, find simplicity. From discord, find harmony. In the middle of difficulty, lies opportunity.’ Albert Einstein
-## Ideation
+### Ideation
### Instructions
@@ -180,7 +180,7 @@ Quote:
- "Brainstorming means using the brain to storm a creative problem. Do so in commando fashion, with each stormer attacking the same objective.’ Alex Faickney Osborn
-## User flow
+### User flow
### Instructions
@@ -210,7 +210,7 @@ Don't forget to:
"Each use case is represented as a sequence of simple steps, beginning with a user’s goal and ending when that goal is fulfilled.’ Usability.gov
-## Prototyping
+### Prototyping
### Instructions
@@ -243,4 +243,4 @@ Give another dimension to your user flow and turn it into a paper prototype (6 t
**Quote:**
-Any design is like a joke …if you have to explain it, it’s bad.
\ No newline at end of file
+Any design is like a joke …if you have to explain it, it’s bad.
diff --git a/subjects/user-experience/piscine-ux/music-on/README.md b/subjects/user-experience/piscine-ux/music-on/README.md
index 73da0a5e6..c249421d7 100644
--- a/subjects/user-experience/piscine-ux/music-on/README.md
+++ b/subjects/user-experience/piscine-ux/music-on/README.md
@@ -1,4 +1,4 @@
-## Heuristics
+### Heuristics
**Context:**
@@ -41,7 +41,7 @@ Conduct a heuristic analysis on **one** of these websites:
'If you think design is expensive, you should look at the cost of bad design’ Ralf Speth | Former CEO Jaguar Land Rover
-## Site map
+### Site map
### Instructions
@@ -81,7 +81,7 @@ Stick to the website you have chosen in the previous exercise "heuristics" and d
"The organization, search, and navigation systems that help people to complete tasks, find what they need, and understand what they’ve found’ Peter Morville | Information Architecture for the WWW.
-## JTBD
+### JTBD
### Instructions
@@ -121,7 +121,7 @@ And remember: You are not your user!
- "Documenting the what and why of each element promotes organization and makes the handoff to the development team much smoother." UX Booth
- "When we buy a product, we essentially "hire" something to get a job done. If it does the job well, when we are confronted with the same job, we hire that same product again. And if the product does a crummy job, we "fire" it and look around for something else we might hire to solve the problem." Clayton M Christensen
-## Card sorting
+### Card sorting
### Instructions
@@ -168,7 +168,7 @@ Don't forget to:
- [10 things to know about card sorting](http://www.measuringu.com/blog/card-sorting.php)
- [Card sorting: a definitive guide](http://boxesandarrows.com/card-sorting-a-definitive-guide/)
-## Music label wireframes
+### Music label wireframes
### Instructions
@@ -218,7 +218,7 @@ Vocabulary:
- Figma.
-## Test protocol
+### Test protocol
### Instructions
@@ -257,7 +257,7 @@ Don't forget to:
- You need to detect: How many errors do users make? How severe are these errors? How easily can they recover from the errors?
-## Run 5 tests
+### Run 5 tests
### Instructions
@@ -287,4 +287,4 @@ Don't forget to:
**Quote:**
-- To get trustworthy results in your test, you can’t ask your customers to use their imagination. You’ve got to show them something realistic. If you do, their reactions will be genuine.
\ No newline at end of file
+- To get trustworthy results in your test, you can’t ask your customers to use their imagination. You’ve got to show them something realistic. If you do, their reactions will be genuine.
diff --git a/subjects/user-experience/piscine-ux/seamstress/README.md b/subjects/user-experience/piscine-ux/seamstress/README.md
index 7ce1d6c39..dbd60f794 100644
--- a/subjects/user-experience/piscine-ux/seamstress/README.md
+++ b/subjects/user-experience/piscine-ux/seamstress/README.md
@@ -1,4 +1,4 @@
-## UX strategy
+### UX strategy
**Context:**
@@ -49,7 +49,7 @@ Don't forget to:
- Design needs to fail. Failure is even a necessary step, but ideally it should happen before a product is launched, during the prototype and test phases
- “UX Strategy lies at the intersection of UX and business. It provides a much better chance of creating successful products. It enables teams to see the “Big Picture” to achieve the business goals under uncertain conditions” Jamie Levy | UX Strategy: How to Devise Innovative Digital Products That People Want
-- UX Strategy is the method by which you validate that your solution solves a problem for real customers in a dynamic marketplace because the market is constantly changing.
+- UX Strategy is the method by which you validate that your solution solves a problem for real customers in a dynamic marketplace because the market i#s constantly changing.
## Empathy
@@ -111,7 +111,7 @@ Don't forget to:
- With 5 to 10 criteria
- 10 organizations appear on the table
-## Define
+### Define
### Instructions
@@ -158,7 +158,7 @@ Don't forget to:
- The "I want to" part involves a practical action.
- The "So I can" part involves a psychological or emotional purpose.
-## Problem statement
+### Problem statement
### Instructions
@@ -199,7 +199,7 @@ Design is about solving problems. Fall in Love with the Problem, Not the Solutio
- How might make sure Pierre doesn’t get drunk the night before the race?
- Out of scope —> This is not about dehydration, nor about running.
-## Ideation
+### Ideation
### Instructions
@@ -221,7 +221,7 @@ Don't forget to:
- Use as many tools as needed, and make sure you do all the process in 4 working days!
- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Prototype
+### Prototype
### Instructions
@@ -265,7 +265,7 @@ Don't forget to:
- High-Fidelity: Wireframes with color, styles, graphical details, and micro-interactions - [Example here](https://miro.medium.com/max/1400/1*Xn0HSKAvhr4TZzC9lN5udw.gif)
- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
-## Test protocol
+### Test protocol
### Instructions
@@ -295,4 +295,4 @@ Don't forget to:
**Tips:**
-- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
\ No newline at end of file
+- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
diff --git a/subjects/user-experience/piscine-ux/sunday-night-movie/README.md b/subjects/user-experience/piscine-ux/sunday-night-movie/README.md
index f85540f21..1612a41e2 100644
--- a/subjects/user-experience/piscine-ux/sunday-night-movie/README.md
+++ b/subjects/user-experience/piscine-ux/sunday-night-movie/README.md
@@ -1,4 +1,4 @@
-## User flow
+### User flow
**Context:**
@@ -39,7 +39,7 @@ Don't forget to:
**Recommended tools:**
- Figma.
-- Whimsical.
+- Whimsical.#
## Movie wireframes
@@ -79,7 +79,7 @@ Don't forget to:
- "77% of users return to content and information sites because of ease-of-use. Only 22% return because the site belongs to a favorite brand." Forrester
-## Wireframes animation
+### Wireframes animation
### Instructions
@@ -106,7 +106,7 @@ Don't forget to:
- [Efficiently Manage Your Designs - How Mockplus State Page Helps To View & Manage Multiple State](https://help.mockplus.com/p/372)
-## Test on features
+### Test on features
### Instructions
@@ -140,7 +140,7 @@ Don't forget to:
- [The art of guerrilla usability testing](http://www.uxbooth.com/articles/the-art-of-guerrilla-usability-testing/)
- [How to write a user testing report that people will actually read](https://uxdesign.cc/how-to-write-a-user-testing-report-that-people-will-actually-read-652d15d2f92e)
-## Iteration
+### Iteration
### Instructions
@@ -166,4 +166,4 @@ Don't forget to:
**Tips:**
- This report will be handed on to the CEO. Pay attention to the details and make sure the document is clean and easy to use!
-- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
\ No newline at end of file
+- Pay attention to the global aspect of the deliverables. They must be clear, simple and easy to read. You can get inspiration [canva](https://www.canva.com/) but don’t overload your design with too much details!
diff --git a/subjects/user-experience/piscine-ux/teenage-drama/README.md b/subjects/user-experience/piscine-ux/teenage-drama/README.md
index 8f2ddf161..ca199954d 100644
--- a/subjects/user-experience/piscine-ux/teenage-drama/README.md
+++ b/subjects/user-experience/piscine-ux/teenage-drama/README.md
@@ -1,4 +1,4 @@
-## Competitive Analysis
+### Competitive Analysis
**Context:**
@@ -43,7 +43,7 @@ Don't forget to:
**Quote:**
- 'Always design a thing in its larger context: a chair in a room, a room in a house, a house in an environment, an environment in a city plan’ Eero Sarrinen | Knoll
-- Creating a great design isn’t just about understanding what the user wants. It’s also about understanding and delivering on what the business needs.
+- Creating a great design isn’t just about understanding what the user wants. It’s also about understanding and delivering on what the business needs.#
## Surveys
@@ -99,7 +99,7 @@ Here are the recommended steps:
- “Surveys measure and categorize attitudes or collect self-reported data that can help track or discover important issues to address.” Norman Nielsen Group
- Surveys are not accurate in providing behavioral data because USERS OMIT STEPS IN THE MIDDLE AND MEMORIES ARE FAULTY.
-## Broadcast strategy
+### Broadcast strategy
### Instructions
@@ -141,7 +141,7 @@ Once your strategy is prepared, run it!
- [How to get more survey responses](https://rafflepress.com/how-to-get-more-survey-responses/)
-## Interviews
+### Interviews
### Instructions
@@ -183,7 +183,7 @@ Here are the recommended steps :
- [How to design better products through user interviews](https://uxdesign.cc/how-to-design-better-products-through-user-interviews-4c5142bb1fc4)
- [Asking the right questions](https://uxdesign.cc/asking-the-right-questions-on-user-research-interviews-and-testing-427261742a67)
-## Personas
+### Personas
### Instructions
@@ -215,7 +215,7 @@ Your persona card should include common trends amongst the people you got data f
- "If you design for everyone, you delight no one."
- "A good user persona is the one based on user research, without regard to how many attributes we can describe."
-## User journey
+### User journey
### Instructions
@@ -254,7 +254,7 @@ Most articles you'll find will be about user journeys or customer journeys. Keep
- “More options = More problems.” Scott Belsky | VP of Product & Community Adobe
- "A customer journey map is a visualization of the process that a person goes through in order to accomplish a goal. It’s used for understanding and addressing customer needs and pain points’ Norman Nielsen Group
-## Problem statement
+### Problem statement
### Instructions
diff --git a/subjects/user-experience/piscine-ux/the-olympics/README.md b/subjects/user-experience/piscine-ux/the-olympics/README.md
index 79e366d1b..1caa19e10 100644
--- a/subjects/user-experience/piscine-ux/the-olympics/README.md
+++ b/subjects/user-experience/piscine-ux/the-olympics/README.md
@@ -1,4 +1,4 @@
-## Ideation A
+### Ideation A
**Context:**
@@ -51,7 +51,7 @@ Don't forget to:
- [3 proven methods to organize a brainstorming session](https://uxdesign.cc/brainstorm-79e51f20f313)
- [Effective brainstorming (without feeling lost)](https://uxdesign.cc/effective-brainstorming-without-being-lost-b68750bbfac5?sk=5d5a332f7e3f2a43364c031b01b13229)
- [The myth of brainstorming](https://uxdesign.cc/the-myth-of-brainstorming-8517e02facc0?sk=995d601cbf988d574e86dd71364cb92f)
-- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to-use-the-best-ideation-methods-worst-possible-idea)
+- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to#-use-the-best-ideation-methods-worst-possible-idea)
## Ideation B
@@ -102,7 +102,7 @@ Pay attention not to use the same ideation technique as in Ex 1!
- [The myth of brainstorming](https://uxdesign.cc/the-myth-of-brainstorming-8517e02facc0?sk=995d601cbf988d574e86dd71364cb92f)
- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to-use-the-best-ideation-methods-worst-possible-idea)
-## Ideation C
+### Ideation C
### Instructions
@@ -151,7 +151,7 @@ Pay attention not to use the same ideation technique as in Ex 2!
- [The myth of brainstorming](https://uxdesign.cc/the-myth-of-brainstorming-8517e02facc0?sk=995d601cbf988d574e86dd71364cb92f)
- [Ideation method: Worst possible idea](https://www.interaction-design.org/literature/article/learn-how-to-use-the-best-ideation-methods-worst-possible-idea)
-## User flow
+### User flow
### Instructions
@@ -178,7 +178,7 @@ Don't forget to:
- [Site flows vs User Flows](https://uxmovement.com/wireframes/site-flows-vs-user-flows-when-to-use-which/)
- [How to make a User Flow diagram](https://www.lucidchart.com/blog/how-to-make-a-user-flow-diagram)
-## Prototyping
+### Prototyping
### Instructions
@@ -219,7 +219,7 @@ Don't forget to:
- "To prototype your solution, you’ll need a temporary change of philosophy: from perfect to just enough, from long-term quality to temporary simulation."
- "The prototype is meant to answer questions, so keep it focused. You just need a real-looking facade to which customers can react."
-## Animation
+### Animation
### Instructions
@@ -244,7 +244,7 @@ This exercise is to be made individually.
- [Efficiently Manage Your Designs - How Mockplus State Page Helps To View & Manage Multiple State](https://help.mockplus.com/p/372)
-## Test wireframe
+### Test wireframe
### Instructions
@@ -280,4 +280,4 @@ Don't forget to:
**Quote:**
-Prototypes are created for testing purposes, that’s why creating a prototype without running tests on it makes no sense.
\ No newline at end of file
+Prototypes are created for testing purposes, that’s why creating a prototype without running tests on it makes no sense.
diff --git a/subjects/user-experience/projects/a-table/audit/README.md b/subjects/user-experience/projects/a-table/audit/README.md
index e135adf6f..91b03aca4 100644
--- a/subjects/user-experience/projects/a-table/audit/README.md
+++ b/subjects/user-experience/projects/a-table/audit/README.md
@@ -1,6 +1,6 @@
#### A table
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
diff --git a/subjects/user-experience/projects/get-a-room/audit/README.md b/subjects/user-experience/projects/get-a-room/audit/README.md
index 4e29cbb7a..85beb00c5 100644
--- a/subjects/user-experience/projects/get-a-room/audit/README.md
+++ b/subjects/user-experience/projects/get-a-room/audit/README.md
@@ -1,6 +1,6 @@
#### Get a room
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
diff --git a/subjects/user-experience/projects/lets-do-some-sports/audit/README.md b/subjects/user-experience/projects/lets-do-some-sports/audit/README.md
index 680df33d7..fd09c4ae1 100644
--- a/subjects/user-experience/projects/lets-do-some-sports/audit/README.md
+++ b/subjects/user-experience/projects/lets-do-some-sports/audit/README.md
@@ -1,6 +1,6 @@
#### Let's do some sports
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
diff --git a/subjects/user-experience/projects/lets-fair-trade/README.md b/subjects/user-experience/projects/lets-fair-trade/README.md
index e229a223d..043c7e190 100644
--- a/subjects/user-experience/projects/lets-fair-trade/README.md
+++ b/subjects/user-experience/projects/lets-fair-trade/README.md
@@ -4,7 +4,7 @@ Creation of an ecommerce platform for second-hand clothes on desktop and mobile
Bruno loves fashion. He loves buying clothes! As he is cautious with the environment, he prefers buying second-hand clothing. However, the existing platforms are not very user-friendly.
-"I need to know more about the environmental impact of the pieces I buy. I’d like to know how old they are, where they are coming from, to measure their life and the amount of kilometres they have traveled. When a new pair of jeans arrive at the ready-to-wear store in Europe, they consumed approximately 11,000 litres of water and travelled 65,000 kilometres. I’d like to monitor that kind of data.’
+"I need to know more about the environmental impact of the pieces I buy. I’d like to know how old they are, where they are coming from, to measure their life and the amount of kilometers they have traveled. When a new pair of jeans arrive at the ready-to-wear store in Europe, they consumed approximately 11,000 litres of water and traveled 65,000 kilometers. I’d like to monitor that kind of data.’
You gather a team of 3 to think and design a website and an app for second-hand products.
diff --git a/subjects/user-experience/projects/lets-fair-trade/audit/README.md b/subjects/user-experience/projects/lets-fair-trade/audit/README.md
index 211d80533..1aa8e8b32 100644
--- a/subjects/user-experience/projects/lets-fair-trade/audit/README.md
+++ b/subjects/user-experience/projects/lets-fair-trade/audit/README.md
@@ -1,6 +1,6 @@
#### Let's fair trade!
-###### At least 5 people are attending the presentation
+###### Are there at least 5 people attending the presentation?
###### Have the feedback forms been shared at the beginning of the presentation?
+
+
+
+
+
+
+
+
+
+
+
+
+
+### Bonus
+
+- Add a health system to both the player character and the enemy character. (look into `Components`)
+- Add a simple crouch to your locomotion system.
+- more mechanics as you see fit for your game.
+- Create a simple `Game Design Document` where you describe your mechanics and how are you planning to implement them.
+
+### Submission
+
+- In your repository there should be a zip file of a build of your game for your target platform.
+ > If it is not possible to upload files to Gitea due to their size, use GitHub instead and have a look at [Git LSF](https://docs.github.com/en/repositories/working-with-files/managing-large-files/about-large-files-on-github)
+
+### Resources
+
+- [Animation Blueprints](https://dev.epicgames.com/documentation/en-us/unreal-engine/animation-blueprints-in-unreal-engine)
+- [Actor Components](https://dev.epicgames.com/documentation/en-us/unreal-engine/components-in-unreal-engine)
+- [Mixamo for animations and character models](https://www.mixamo.com/)
+- [SketchFab for 3D models](https://sketchfab.com/)
+- [itch.io for more assets](https://itch.io/)
diff --git a/subjects/gaming/2-5-d-adventure/audit/README.md b/subjects/gaming/2-5-d-adventure/audit/README.md
new file mode 100644
index 000000000..c370d859d
--- /dev/null
+++ b/subjects/gaming/2-5-d-adventure/audit/README.md
@@ -0,0 +1,89 @@
+> Due to file size reason, the solution might be uploaded on GitHub instead of Gitea!
+
+#### General
+
+##### If, at any point during the audit, coupled code is detected that could have been resolved using the Observer pattern (`event dispatchers`), the audit will stop, and the student will fail the project.
+
+###### Is the game following a coherent theme ?
+
+#### Main Menu
+
+###### Is the main menu widget on a separate level/map from the main game map?
+
+###### Does the main menu contain a Start game button?
+
+###### Does the main menu contain an Exit game button?
+
+#### Player Character
+
+###### Does the player character have a skeletal mesh?
+
+###### Can the player character move only along two axes: left-right and up-down?
+
+###### Does the player character have a basic locomotion system with all the required animations?
+
+###### Does the player character transition smoothly between walking and running animations based on their speed?
+
+#### Collectible
+
+###### Does the collectible Actor have a static mesh?
+
+###### Does the collectible rotate around an axis?
+
+###### Does the collectible have a box collider that acts as a trigger?
+
+###### Is the collectible collected when the player enters its box trigger?
+
+###### Does the collectible play a sound when collected?
+
+#### HUD
+
+###### Does the HUD widget display a value related to the `collectible`?
+
+###### Is the HUD updated each time a `collectible` is picked up?
+
+###### Is the HUD also updated when picking a `collectible` that spawned from killing an enemy?
+
+#### Enemy
+
+###### Does the enemy character have a skeletal mesh?
+
+###### Does the enemy character have at least a walking cycle?
+
+###### Does the enemy character have a simple AI that patrols between two set points?
+
+###### Does the enemy character kill the player on collision?
+
+###### Is the enemy character killed if the player lands on top of it?
+
+###### Does the enemy character play a sound when killed?
+
+###### Does the enemy character create an instance of a `Collectible` at the place of death?
+
+#### Game loop
+
+###### Is there a spawn point where the player starts?
+
+###### Does the player respawn at the spawn point when dead?
+
+###### Is there an end point that defines the player’s goal to finish the level?
+
+###### When the player reaches the end point, is a menu displayed with options to restart or quit the game?
+
+#### Level design
+
+###### Does the level design avoid being just a long, empty run to the finish point?
+
+###### Does the level include mechanics chosen by the student? `(e.g. moving platforms skill-based platforming)`
+
+###### Does the level provide a fun and challenging experience for the player?
+
+#### Bonus
+
+###### +Has a health system been added to both the player character and the enemy character using Components?
+
+###### +Has a simple crouch been added to the player character's locomotion system?
+
+###### +Have additional mechanics been implemented to fit the overall game design?
+
+###### +Has a simple Game Design Document been created that describes the mechanics and outlines the plan for implementing them?
diff --git a/subjects/gaming/2-5-d-adventure/resources/1.jpg b/subjects/gaming/2-5-d-adventure/resources/1.jpg
new file mode 100755
index 000000000..4222cc2e3
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/1.jpg differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/collectible.gif b/subjects/gaming/2-5-d-adventure/resources/collectible.gif
new file mode 100755
index 000000000..dbf91d293
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/collectible.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/enemydie.gif b/subjects/gaming/2-5-d-adventure/resources/enemydie.gif
new file mode 100755
index 000000000..62ec093dc
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/enemydie.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif b/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif
new file mode 100755
index 000000000..dedd1cb95
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/enemywalk.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/hud.gif b/subjects/gaming/2-5-d-adventure/resources/hud.gif
new file mode 100755
index 000000000..904d0cdfc
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/hud.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/locomotion.gif b/subjects/gaming/2-5-d-adventure/resources/locomotion.gif
new file mode 100755
index 000000000..b8de0e007
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/locomotion.gif differ
diff --git a/subjects/gaming/2-5-d-adventure/resources/platformer.jpg b/subjects/gaming/2-5-d-adventure/resources/platformer.jpg
new file mode 100755
index 000000000..52c4ff8e9
Binary files /dev/null and b/subjects/gaming/2-5-d-adventure/resources/platformer.jpg differ
diff --git a/subjects/gaming/firing-range/README.md b/subjects/gaming/firing-range/README.md
index 4775ebc60..6fdd1c1f1 100644
--- a/subjects/gaming/firing-range/README.md
+++ b/subjects/gaming/firing-range/README.md
@@ -1,39 +1,125 @@
-## FiringRange
+## Firing-range
-In this exercise, you will learn to use the Unreal Engine and Blueprints to script functionalities of a basic FPS game. The theme is to reproduce a firing range. And remember, weapons are allowed only inside the shooting area!!
+### Overview
+
+This project involves creating a fully functional firing range in Unreal Engine 5 (UE5). You will focus on implementing shooting mechanics, a weapon system, player input handling, physics for projectiles, and basic AI to control moving targets. Your task is to build a simple environment where the player can shoot targets, and all systems should work seamlessly together.
+
+
+
+
+
+
+
+
+