Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Amin authored and Amin committed Jan 22, 2024
1 parent 8884e7f commit 7f770e3
Showing 1 changed file with 7 additions and 24 deletions.
31 changes: 7 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

---

Inspired by the [cookiecutter-data-science](https://github.com/drivendata/cookiecutter-data-science) template. This
template has been updated to better fit machine learning-based projects and is being used as the core template in
this [MLOps course](https://github.com/SkafteNicki/dtu_mlops).
Forked from [MLOps course template](https://github.com/SkafteNicki/dtu_mlops). This template has been updated
to better fit deep learning projects and contain more features out of the box.

## Requirements to use the template:

Expand All @@ -13,35 +12,17 @@ this [MLOps course](https://github.com/SkafteNicki/dtu_mlops).

## Start a new project

Start by creating a repository either using the Github GUI in the webbrowser or alternatively you can use the
[Github command line interface](https://cli.github.com/) if you have set it up:
On your local machine run

```bash
gh repo create <repo_name> --public --confirm
cookiecutter https://github.com/Black3rror/DL_project_template
```
Afterwards on your local machine run

```bash
cookiecutter https://github.com/SkafteNicki/mlops_template
```

and input starting values for the project. When asked for the repository name when creating the template,
input the same name as when you created the repository. Note that when asked for the project name, you should input
and input starting values for the project. Note that when asked for the project name, you should input
a [valid Python package name](https://peps.python.org/pep-0008/#package-and-module-names). This means that the name
should be all lowercase and only contain letters, numbers and underscores. The project name will be used as the name of
the Python package. This will automatically be validated by the template.

To commit to the remote repository afterwards execute the following set of commands:

```bash
cd <repo_name>
git init
git add .
git commit -m "init cookiecutter project"
git remote add origin https://github.com/<username>/<repo_name>
git push origin master
```

## The stack

🐍 Python projects using `pyproject.toml` <img src="icons/python.svg" width="20" height="20">
Expand All @@ -57,3 +38,5 @@ git push origin master
✅ Checking using `pre-commit` <img src="icons/precommit.svg" width="20" height="20">

🛠️ CI with `Github actions` <img src="icons/githubactions.svg" width="20" height="20">

and more...

0 comments on commit 7f770e3

Please sign in to comment.