S.O.L.I.D. Principles for Machine Learning
Explore
the
docs
»
Table of Contents
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
- Clone the repository
git clone https://github.com/jpcadena/solid-principles-machine-learning.git - Change the directory to root project
cd solid-principles-machine-learning - Install Poetry package manager
pip install poetry - Install the project's dependencies
poetry install - Activate the environment
poetry shell
-
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
Please read our contributing guide for details on our code of conduct, and the process for submitting pull requests to us.
For security considerations and best practices, please refer to our Security Guide for a detailed guide.
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.
Distributed under the MIT License. See LICENSE for more information.
