Machine Learning Laptop Setup

This repo is designed to run on Ubuntu, and is verified in version 20.04. You must have git installed and have admin rights.

Initial Setup

Install git

sudo apt-get update
sudo apt-get install git

Clone this repo

Navigate to your user root directory and pull this repo:

cd ~
git clone https://github.com/espressoAndCode/ml-laptop-setup.git

Run the installation script

Note: You will be asked to enter your sudo password.

cd ml-laptop-setup
bash setup.sh && source $HOME/.bashrc

PYTHONPATH setup in virtual environment

This step is not mandatory, but it's nice to have. The project automatically includes a folder called pythonmodules where you can store all of your project-specific reusable python modules. If you add the following code, the PYTHONPATH environment variable will be set automatically when you activate the env, and cleared when you deactivate.

From your top-level project folder, navigate to the env/bin/activate file. The first function you will see is deactivate. Add a line and enter export PYTHONPATH="" as shown here:

deactivate () {
    export PYTHONPATH=""    ### ADD THIS LINE ###
    # reset old environment variables
    ...

Note: If your main os has a PYTHONPATH configured, enter that instead of the empty string. This is the python path that will be set when you deactivate the project's virtual environment.

Next, add the following code to the end of the activate file:

PROJDIR=$(echo "$VIRTUAL_ENV" | sed 's|\(.*\)/.*|\1|')
export PYTHONPATH="$PROJDIR/pythonmodules"

This will cause the PYTHONPATH environment variable to be automatically set to the pythonmodules folder inside your project.

If you want to add additional module paths in your project, you can modify the last line as follows:

export PYTHONPATH="$PROJDIR/pythonmodules:$PROJDIR/<another module>:$PROJDIR/<yet another module>"

Usage Instructions

To create a new python project

You can create a new project from anywhere, it will be set up in the Dev folder. The first command will navigate you into the project folder. If you have additional dependencies, you can add them to the requirements.txt file prior to running the pip install line o you can add them later. It's fine to run this multiple times, as the previously installed dependencies are cached and will not be re-installed.

mpp <project-name>
makeenv
act <project-name>
pip install -r requirements.txt

To activate an existing project

You can execute this command from anywhere, it will navigate to the project in the Dev folder. Don't forget to include the project name!

act <project-name>

To deactivate a running environment

Run this command from inside the project folder. Alternatively, you can just close the terminal.

dct

Keybindings Reference

##### Custom .bashrc additions #####

alias dc='docker-compose'
alias dcup='docker-compose up'
alias dcdn='docker-compose down'
alias makeenv='python3.10 -m venv env'                  # Create a new venv
alias dct='deactivate'                                  # Deactivate the virtual env
alias tboard='tensorboard --logdir tensorboardlogs/fit' # Launch Tensorboard

### Generic ENV activation
    # Example: act <proj-name>
act(){
    cd $HOME/Dev/$1
    . env/bin/activate
    code .
}

### Make Python project
    # Example: mpp <proj-name>
mpp(){
mkdir $HOME/Dev/$1
cd $HOME/Dev/$1
git init
mkdir pythonmodules
cp $HOME/Dev/_templates/requirements.txt requirements.txt 
cp $HOME/Dev/_templates/README.md README.md
cp $HOME/Dev/_templates/.gitignore_py .gitignore
cp $HOME/Dev/_templates/main.py main.py
}

Sanity Checks

Docker

The Docker daemon process should start on completion of the installation script, and on boot. Run the following if you need to verify.

sudo systemctl status docker
# Kill the process with Ctrl-C

VS Code

Run the following to verify the VSCode version.

code --version 

Documentation

• Python 3.10
• Tensorflow
• Docker
• Docker Compose
• VS Code

Version History

• 0.2 - 4/1/2022
  • Add logic to prevent creating (and thus overwriting) a project with an existing project name.
  • Add logic to not overwrite existing Dev or Data files in re-install.
  • Add version check to allow additional .bashrc mods without overwriting or duplicating previous mods.
  • Note - the _templates folder is not protected, and WILL be overwritten on re-installation.
• 0.1
  • Initial Release