https://github.com/diogo364/solid-for-ml

https://github.com/diogo364/solid-for-ml

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/diogo364/solid-for-ml
• Owner: Diogo364
• License: mit
• Created: 2022-10-14T21:00:46.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-04T17:56:15.000Z (about 2 years ago)
• Last Synced: 2024-10-12T22:53:35.449Z (about 1 month ago)
• Language: Python
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# SOLID For Machine Learning

## What is SOLID

"In software engineering, SOLID is a mnemonic acronym for five design principles intended to make object-oriented designs more understandable, flexible, and maintainable. The principles are a subset of many principles promoted by American software engineer and instructor Robert C. Martin, first introduced in his 2000 paper Design Principles and Design Patterns." - Wikipedia

## Description

This project intends to explain how to apply the SOLID principles to Machine Learning codes and its main benefits.

## Setting Environment

For setting the environment, one might use one of the following methods:

### 1. Make

It is possible to use `Make` to set the entire environment. 

1. Open the `Makefile` file in your editor and update the `SHELL` variable according to your system.

2. run the `setup` command from `Make`:

    ```

    make setup

    ```

3. Now you're good to go!

### 2. Conda

It is possible to create the conda environment by following the following steps:

1. Create the conda env using the `environment.yml` file

    ```

    conda env create -f environment.yml

    ```

2. Activate the the `solid-ml` env

   ```

    conda activate solid-m

   ```

3. follow the steps in the Download Data section.

### 3. Venv 

It is also possible to use `Python's` `venv` following the following steps:

1. Create the `venv`

    ```

    python -m venv solid-ml

    ```

2. Activate the the `solid-ml` env

   ```

    # This command works for linux. Refer to venv documentation

    source solid-ml/bin/activate

   ```

3. follow the steps in the Download Data section.

## Download Data

To get the data, you must execute the `get_wine_data.py` python script from the `setup` folder.

```

python setup/get_wine_data.py

```

> **IMPORTANT:** If you used Make to setup the environment you don't need to run this step

## Requirements

- `conda==4.13.0`

- `python==3.10`