ML project structure in ML Python

Introduction

Having a clear ML project structure helps keep your work organized and easy to follow. It makes teamwork and future updates simpler.

When starting a new machine learning project to keep files tidy.

When working with others so everyone understands where things are.

When you want to reuse parts of your project in the future.

When you need to track experiments and results clearly.

When preparing your project for deployment or sharing.

Syntax

ML Python

project_name/
  ├── data/
  │    ├── raw/
  │    ├── processed/
  ├── notebooks/
  ├── src/
  │    ├── data_processing.py
  │    ├── model.py
  │    ├── train.py
  ├── tests/
  ├── models/
  ├── outputs/
  │    ├── figures/
  │    ├── logs/
  ├── requirements.txt
  ├── README.md
  └── setup.py

The data/ folder stores your datasets, separated into raw and processed.

The src/ folder contains your code files like data processing and model training.

Examples

Keep original data in raw/ and cleaned or transformed data in processed/.

ML Python

project_name/
  ├── data/
  │    ├── raw/
  │    ├── processed/

Use notebooks/ for experiments and src/train.py for your training script.

ML Python

project_name/
  ├── notebooks/
  ├── src/
  │    ├── train.py

Save trained models in models/ and results like graphs and logs in outputs/.

ML Python

project_name/
  ├── models/
  ├── outputs/
  │    ├── figures/
  │    ├── logs/

Sample Model

This code creates the main folders for a machine learning project. It helps you start with a clean and organized setup.

ML Python

import os

# Create folders for ML project structure
folders = [
    'data/raw',
    'data/processed',
    'notebooks',
    'src',
    'tests',
    'models',
    'outputs/figures',
    'outputs/logs'
]

for folder in folders:
    os.makedirs(folder, exist_ok=True)

print('Folders created:')
for folder in folders:
    print(f'- {folder}')

Important Notes

Keep your code and data separate to avoid confusion.

Use README.md to explain your project and how to run it.

Track dependencies in requirements.txt for easy setup.

Summary

Organize your ML project with clear folders for data, code, models, and outputs.

Separate raw and processed data to keep original files safe.

Use notebooks for exploration and scripts for training and processing.

Practice

1. Which folder in an ML project should you use to store the original, untouched data files?

easy

A. Raw data folder

B. Processed data folder

C. Models folder

D. Scripts folder

Solution

1. Step 1: Understand the purpose of raw data folder

   The raw data folder is meant to keep the original data safe and unchanged.

2. Step 2: Differentiate from processed data folder

   The processed data folder contains cleaned or transformed data, not the original files.

3. Final Answer:

   Raw data folder -> Option A

4. Quick Check:

   Original data = Raw data folder [OK]

Hint: Original files go to raw data folder to keep them safe [OK]

Common Mistakes:

• Putting original data in processed folder
• Mixing models with data files
• Saving scripts in data folders

2. Which of the following is the correct way to organize code in an ML project?

easy

A. Put all code, notebooks, and models in one folder

B. Keep processed data and scripts mixed in one folder

C. Separate notebooks for exploration and scripts for training

D. Save models inside the raw data folder

Solution

1. Step 1: Identify the role of notebooks and scripts

   Notebooks are for exploring data and ideas; scripts are for running training and processing tasks.

2. Step 2: Understand folder separation

   Keeping notebooks and scripts separate helps keep the project organized and clear.

3. Final Answer:

   Separate notebooks for exploration and scripts for training -> Option C

4. Quick Check:

   Notebooks ≠ scripts folder [OK]

Hint: Use notebooks for exploring, scripts for running training [OK]

Common Mistakes:

• Mixing notebooks and scripts in one folder
• Saving models in data folders
• Putting all files in one folder

3. Given this ML project folder structure:

project/
├── data/
│   ├── raw/
│   └── processed/
├── notebooks/
├── scripts/
└── models/

Where should you save a trained model file after training?

medium

A. data/raw/

B. scripts/

C. notebooks/

D. models/

Solution

1. Step 1: Understand folder purposes

   The models folder is designed to store trained model files for reuse and deployment.

2. Step 2: Exclude other folders

   Data folders are for data files, notebooks for exploration, scripts for code execution, so models belong in models/.

3. Final Answer:

   models/ -> Option D

4. Quick Check:

   Trained model files go to models folder [OK]

Hint: Save trained models in the models folder [OK]

Common Mistakes:

• Saving models in data folders
• Putting models inside notebooks folder
• Confusing scripts folder with models

4. You find that your ML project has raw data and processed data mixed in the same folder. What is the best fix?

medium

A. Rename all files to indicate if they are raw or processed

B. Move raw data to a separate 'raw' folder and processed data to 'processed' folder

C. Delete the processed data and keep only raw data

D. Keep all data in one folder but add a README explaining the files

Solution

1. Step 1: Identify the problem

   Mixing raw and processed data risks overwriting or confusion about data versions.

2. Step 2: Organize data properly

   Separating raw and processed data into different folders keeps original data safe and processed data clear.

3. Final Answer:

   Move raw data to a separate 'raw' folder and processed data to 'processed' folder -> Option B

4. Quick Check:

   Separate raw and processed data folders [OK]

Hint: Keep raw and processed data in separate folders [OK]

Common Mistakes:

• Deleting processed data unnecessarily
• Only renaming files without moving
• Relying on README without folder separation

5. You want to share your ML project with a teammate. Which folder should you exclude to keep the project size small and avoid sharing large temporary files?

hard

A. outputs/

B. data/raw/

C. models/

D. notebooks/

Solution

1. Step 1: Identify large temporary files

   The outputs folder usually contains temporary results like logs, plots, or intermediate files that can be large and rebuilt.

2. Step 2: Decide what to share

   Models, raw data, and notebooks are important for reproducing work, so outputs can be excluded to save space.

3. Final Answer:

   outputs/ -> Option A

4. Quick Check:

   Exclude outputs folder to reduce project size [OK]

Hint: Exclude outputs folder to avoid sharing large temp files [OK]

Common Mistakes:

• Excluding raw data which is needed
• Removing models folder by mistake
• Not excluding any folder and sharing everything