-
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update documentation for pre-release v0.1.0-beta
- Loading branch information
1 parent
32d9924
commit 0513013
Showing
1 changed file
with
8 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,11 @@ | ||
# Changelog | ||
|
||
<p align = "justify">All notable changes to this <code><b>repository</b></code> will be documented here. The format is based on <a href = "https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>, and this project adheres to <a href = "https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p> | ||
|
||
## [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. |