diff --git a/CHANGELOG.md b/CHANGELOG.md index bd5e8dc..af478e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ # Changelog

All notable changes to this repository will be documented here. The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

+ +## [v0.1.0-beta](https://github.com/ZenithClown/ai-ml-project-template/releases/tag/v0.1.0-beta) + +A template for quickly starting a machine learning, artificial intelligence or data science project. The repository contains all necessary files and structure that might be used in a project. This pre-release contains the following: + 1. Seperate directory structure for safe keeping [data](data) and [output](output) from code files. + 2. [Notebooks](notebooks) directory can be used for storing Jupyter Notebooks. + 3. Seperate [src](src) directory that contains [agents](src/agents/), [engine](src/engine/) and [models](src/models/) for configuring any reinforcement learning project. This directory (if not required) can be removed. + 4. The [static](static) and [utilities](utilities) can be used to store additional files, while [logs](logs) is an essential files for tracking code progress.