Skip to content

jpcadena/solid-principles-machine-learning

Repository files navigation

solid-principles-machine-learning


Logo

S.O.L.I.D. Principles for Machine Learning

S.O.L.I.D. Principles for Machine Learning
Explore the docs »

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. Security
  6. Code of Conduct
  7. License
  8. Contact

About The Project

Project

SOLID is an acronym for the first five object-oriented design (OOD) principles by Robert C. Martin (also known as Uncle Bob).

These principles establish practices that lend to developing software with considerations for maintaining and extending as the project grows. Adopting these practices can also contribute to avoiding code smells, refactoring code, and Agile or Adaptive software development.

SOLID stands for:

S - Single-responsibility Principle O - Open-closed Principle L - Liskov Substitution Principle I - Interface Segregation Principle D - Dependency Inversion Principle

(back to top)

Built with

Pythonisort Black Ruff MyPy pre-commitGitHub ActionsPoetryPycharm Visual Studio Code Markdown License: MIT

(back to top)

Getting started

Prerequisites

Installation

  1. Clone the repository
    git clone https://github.com/jpcadena/solid-principles-machine-learning.git
    
  2. Change the directory to root project
    cd solid-principles-machine-learning
    
  3. Install Poetry package manager
    pip install poetry
    
  4. Install the project's dependencies
    poetry install
    
  5. Activate the environment
    poetry shell
    

(back to top)

Usage

  1. Run the program:

    To run the scripts on your machine, run the following command in your terminal by replacing the name of the principle:

    python solid_principles/principle.py
    

(back to top)

Contributing

GitHub

Please read our contributing guide for details on our code of conduct, and the process for submitting pull requests to us.

(back to top)

Security

For security considerations and best practices, please refer to our Security Guide for a detailed guide.

(back to top)

Code of Conduct

We enforce a code of conduct for all maintainers and contributors. Please read our Code of Conduct to understand the expectations before making any contributions.

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

  • LinkedIn

  • Outlook

(back to top)