🚀 Introduction

Welcome to Ultralytics' MATLAB Functions Repository! This hub is a collection of commonly used functions that are essential for various Ultralytics MATLAB projects. These scripts provide a foundation that assists in the development and research phases of machine learning and data analysis within MATLAB. Feel free to explore and utilize these utilities to streamline your work!

For more information about Ultralytics, our mission, and the innovative work we're doing, fly over to our website: Ultralytics.

📘 Description

The functions-matlab repository serves as a centralized store of MATLAB functions. These are the bread-and-butter of our MATLAB codebase, put to use in a plethora of Ultralytics projects. It's designed to promote code reuse and to help maintain consistency across different projects.

📋 Requirements

To run the resources available in this repository, ensure that you have the following:

• MATLAB version 2018a or higher installed on your system.

📥 Installation

Installing and getting started with these functions is a straightforward process:

1. Clone this repository to your local machine:

   $ git clone https://github.com/ultralytics/functions-matlab
   

2. Once cloned, you can add the repository to your MATLAB path to access the functions. Launch MATLAB and run the following command:

   >> addpath(genpath('path_to_cloned_repo/functions-matlab'))
   

   Replace path_to_cloned_repo with the path to the folder where you cloned the repository.

🧰 Usage

To use a function from the repository, simply call it from your MATLAB script or command window as you would with any other MATLAB function. If you have added the repository to your MATLAB path as described above, the functions will be recognized by MATLAB without the need for any additional steps.

🤝 Contribute

We welcome contributions from the community! Whether you're fixing bugs, adding new features, or improving documentation, your input is invaluable. Take a look at our Contributing Guide to get started. Also, we'd love to hear about your experience with Ultralytics products. Please consider filling out our Survey. A huge 🙏 and thank you to all of our contributors!

©️ License

Ultralytics is excited to offer two different licensing options to meet your needs:

• AGPL-3.0 License: Perfect for students and hobbyists, this OSI-approved open-source license encourages collaborative learning and knowledge sharing. Please refer to the LICENSE file for detailed terms.
• Enterprise License: Ideal for commercial use, this license allows for the integration of Ultralytics software and AI models into commercial products without the open-source requirements of AGPL-3.0. For use cases that involve commercial applications, please contact us via Ultralytics Licensing.

📬 Contact Us

For bug reports, feature requests, and contributions, head to GitHub Issues. For questions and discussions about this project and other Ultralytics endeavors, join us on Discord!