1
0
Fork 0

A template repository for my data science and machine learning projects when they are hosted here on XetHub

README.md

Template Repository for Python Projects

This repository is as a template for starting Python projects with the following features:

It is mainly intended for my personal use to start machine learning data science projects but feel free to use it as a starting point for your own projects.

Prerequisites

Before you can use this template, make sure you have Python installed on your system. We are going to use Poetry for dependency management, which needs Python 3.7 or newer.

pip install poetry

To initiate the Poetry environment and install the dependency packages, run the following commands in the shell in the root folder of this repository after downloading it.

poetry update && poetry init

After that, enter the Poetry environment by invoking the poetry's shell using the following command:

poetry shell

Edit the pyproject.toml file to update the project name, description, and other metadata.

Structure

The repository has the following structure:

  • bin/: scripts and executables for command line use
  • data/: data files and datasets
  • src/: source code files
  • notebooks/: Jupyter notebooks files
  • models/: trained models and model files
  • tests/: test files for the source code
  • pyproject.toml: project metadata and dependencies
  • LICENSE: license information
  • README.md: project information and instructions

Feel free to modify the structure to fit your needs.

License

Files in this repository are licensed under the MIT License - see the LICENSE file for details.

File List Total items: 13
Name Last Commit Size Last Modified
bin My initial commit 2 months ago
data My initial commit 2 months ago
models Reorganized the files and folders 4 weeks ago
notebooks Reorganized the files and folders 4 weeks ago
src My initial commit 2 months ago
tests My initial commit 2 months ago
.editorconfig Reorganized the files and folders 402 B 4 weeks ago
.gitattributes Initial commit 79 B 2 months ago
.gitignore My initial commit 884 B 2 months ago
CHANGELOG.md My initial commit 582 B 2 months ago
LICENSE My initial commit 1.0 KiB 2 months ago
README.md Reorganized the files and folders 1.7 KiB 4 weeks ago
pyproject.toml Reorganized the files and folders 462 B 4 weeks ago

About

A template repository for my data science and machine learning projects when they are hosted here on XetHub

Repository Size

Loading repo size...

Commits 3 commits

File Types