🧠

Research project

A boilerplate for research projects

Table of Contents

1. About The Project
   • Built With
   • Directory Structure
2. Getting Started
   • Prerequisites
   • Installation
3. Contact

About The Project

This project is a ...

(back to top)

Built With

• Python
• Poetry

(back to top)

Directory Structure

.
├── alembic/                # Folder for alembic migrations
├── app/                    # Application directory for the project
├── data/                   # Data files
├── docker/                 # Docker configuration files
├── docs/                   # Documentation files
├── models/                 # Trained and serialized models, models predictions, or model summaries
├── notebooks/              # Jupyter notebooks. Naming convention: `<model_name>_<model_version>.ipynb`
├── reports/                # Generated analysis reports as HTML files
├── scripts/                # Folder for scripts
├── .flake8                 # Flake8 configuration file
├── .gitignore              # Ignore files for github
├── alembic.ini             # Alembic configuration file
├── Makefile                # Makefile with commands to build and run the project
├── pyproject.toml          # Project configuration file
└── README.md               # The top-level README file for developers

Getting Started

Instructions for getting started with the project.

Prerequisites

You need to have the following prerequisites installed:

• python 3.9+ macOS:

    brew install [email protected]

• poetry https://python-poetry.org/docs/#installation

Installation

1. Setup the project

   make setup

(back to top)

Contact

Firstname Lastname - [email protected]

(back to top)