🤖
AI Awesome Project Template
You may want to adjust badge links in a README.md file.
💎
Installation with pip
Installation is as simple as running:
pip install git+https://github.com/wiktorlazarski/ai-awesome-project-template
⚙️
Setup for development
Before setting up a project, make sure that the setup.py
script has all setup parameters adjusted and change an ai_awesome
directory name to your project name. Also, if you want to use conda environment, you may want to change its name in a conda_env.yml
file. Then, follow the instruction:
# Clone repo
git clone https://github.com/wiktorlazarski/ai-awesome-project-template.git
# Go to repo directory
cd ai-awesome-project-template
# (Optional) Create virtual environment
python -m venv venv
source ./venv/bin/activate
# Install project in editable mode
pip install -e .
# (Optional but recommended) Install pre-commit hooks to preserve code format consistency
pre-commit install
🐍
Setup for development with Anaconda or Miniconda
Before setting up a project, make sure that the setup.py
script has all setup parameters adjusted and change an ai_awesome
directory name to your project name. Additionally, you may want to change a default (ai_awesome_env) conda environment name in a conda_env.yml
file. Then, follow the instruction:
# Clone repo
git clone https://github.com/wiktorlazarski/ai-awesome-project-template.git
# Go to repo directory
cd ai-awesome-project-template
# Create and activate conda environment
conda env create -f ./conda_env.yml
conda activate ai_awesome_env
# (Optional but recommended) Install pre-commit hooks to preserve code format consistency
pre-commit install