/Marvin.IA

Machine Learning in Object Pascal.

Primary LanguagePascalMIT LicenseMIT

Marvin.IA

License Author Compatibility

Marvin.IA is a machine learning collection of object-oriented Pascal primitives (only interfaces and classes).

ATTENTION: We have very new internal (alpha) versions. We also make changes frequently. Please use it at your own risk until we release a stabilized version that will be displayed as a "stable version".

This API is being written in Delphi. However, making it compatible with Free Pascal and Lazarus is possible (we are depending on more contributors to make it possible).

Why. I want to use Object Pascal (OP) with Machine Learning. The OP is an elegant and very easy language. My desire is to contribute to the entire developer community. I want to keep and write all project in an elegant, clean and maintainable code using OOP.

Principles. The code has some design principles:

  • Fully interface-based.
  • Memory is released automatically.
  • Public methods should be used only for contructors (Create and New) and destructors (Destroy).
  • All protected methods are implementations of interface methods.
  • All protected methods return an interface instance or primitive type.
  • No usage of nil/NULL in arguments or returns.
  • No algorithms in constructors.
  • No getters and setters.
  • No type casting or reflection.
  • No procedures or functions, only Interfaces and Objects.

Dependencies

We are using other packages:

  • Delphi Embarcadero native packages, starting with the XE3 version.

How to contribute?

To contribute we suggest following these steps:

  1. Fork this project (Click on Fork button).
  2. Clone your forked project to your local machine.
  3. Create a new issue describing about the problem or enhancement that you are going to make.
  4. Create a new branch related to this issue. We suggest to use a name like issue-10 — 10 is the issue's ID.
  5. Make all the changes necessary and commit.
  6. Push the new branch to your Github repository.
  7. Go to Marvin.IA Github project and click on Compare & Pull Request.

Important:

  • It is important for you create a new branch for each PR. We might need to request some further changes in your work, and having the original PR's code to make these changes is better than working with the whole code.
  • Each PR needs to work only in one issue, respecting the single responsibility principle.
  • Make sure your branch builds without any warnings/issues.

If you have questions or general suggestions, don't hesitate to submit a new Github issue.

Contributors

License (MIT)

Copyright (c) 2018-2019 Marcus Vinicius D. B. Braga

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.