ikt450 - Deep Learning Systems

Table of Contents

1. Preparations
   • Clone the Repository
   • Setting Up a Virtual Environment
     • Using venv
     • Using conda
   • Setting Up PYTHONPATH
     • On Linux or macOS
     • On Windows
2. Usage
   • For each feature 🔃

Preparations

Clone the Repository:

git clone [email protected]:Jon-Bull/ikt450.git
cd ikt450/

Setting Up a Virtual Environment

Show steps

Using venv (Python's built-in tool):

Show steps

1. Create a Virtual Environment:

   python3 -m venv env

   This will create a directory named env that contains your virtual environment.

2. Activate the Virtual Environment:

   • On Linux or macOS:

     source env/bin/activate

   • On Windows:

     .\env\Scripts\activate

3. Install Required Packages:

   pip install -r requirements.txt

Using conda (if you prefer using Anaconda/Miniconda):

Show steps

1. Create a Conda Environment:

   conda create --name ikt450 python=3.x

   Replace 3.x with the desired Python version.

2. Activate the Conda Environment:

   conda activate ikt450

3. Install Required Packages:

   pip install -r requirements.txt

Setting Up PYTHONPATH

Show steps

To ensure that Python can properly locate the modules within this project, you should add the project's root directory to your PYTHONPATH environment variable. This can be done by adding the following line to your shell configuration file (e.g., .bashrc, .zshrc, .bash_profile, etc.), depending on your operating system:

On Linux or macOS:

Show steps

1. Open your terminal.
2. Edit your .bashrc or .zshrc file:

   nano ~/.bashrc

   or for zsh:

   nano ~/.zshrc

3. Add the following line at the end of the file:

   export PYTHONPATH="${PYTHONPATH}:/REPLACE/THIS/PATH/ikt450/"

4. Save and close the file.
5. Apply the changes by sourcing the file:

   source ~/.bashrc

   or for zsh:

   source ~/.zshrc

On Windows:

Show steps

1. Open Command Prompt as an administrator.
2. Set the PYTHONPATH for your session:

   set PYTHONPATH=%PYTHONPATH%;C:\REPLACE\THIS\PATH\ikt450\

3. To set it permanently, use the setx command:

   setx PYTHONPATH "%PYTHONPATH%;C:\REPLACE\THIS\PATH\ikt450\"

Usage

Show steps

For each feature 🔃

Before	Coding...	After
git pull git checkout -b <feature>	🌟 WRITE AWESOME CODE 🌟	git add . git commit -m "<message>" git push -u origin <feature>

▶️ Open a pull request on GitHub to merge your changes into the main branch.

▶️ Review the changes in the pull request and make any necessary comments or suggestions.

▶️ Once the changes are approved, merge the pull request into the main branch.

▶️ Switch back to the main branch and pull the latest changes:

git checkout main
git pull