Jotaherrera / ludicrum

This repository exemplifies global best practices, ensuring robustness, scalability, and maintainability across its codebase.
MIT License
1 stars 0 forks source link

Define project structure #2

Open Jotaherrera opened 1 month ago

Jotaherrera commented 1 month ago

Feature Request: Define project structure

Description

Make some research about how to set a proper and efficient file structure that fits with the project size and also with our needs.

Requirements

Acceptance Criteria

Additional Context

N\A

Jotaherrera commented 1 month ago

Currently, I'm setting up all the configs for this project, so maybe you could find some issues while trying to add changes. If so, report your problems through the discussion in #1.

You can also share any thoughts related to this issue here so we can discuss the structure decision.

JoansebHM commented 1 month ago

What do you think ab this one? Maybe we can modify some files or even delete them in case that we do not need them.

my_ml_project/
├── data/
│   ├── raw/
│   ├── processed/
│   └── external/
├── notebooks/
│   └── exploration.ipynb
├── src/
│   ├── __init__.py
│   ├── data/
│   │   ├── __init__.py
│   │   ├── load_data.py
│   │   └── preprocess_data.py
│   ├── features/
│   │   ├── __init__.py
│   │   ├── build_features.py
│   ├── models/
│   │   ├── __init__.py
│   │   ├── train_model.py
│   │   ├── predict_model.py
│   ├── utils/
│   │   ├── __init__.py
│   │   └── helper_functions.py
│   └── visualization/
│       ├── __init__.py
│       └── visualize.py
├── tests/
│   ├── __init__.py
│   ├── test_data.py
│   ├── test_features.py
│   ├── test_models.py
│   └── test_visualization.py
├── requirements.txt
├── setup.py
├── README.md
└── .gitignore