🚀 Ultralytics MATLAB Functions

Welcome to the Ultralytics MATLAB Functions Repository! This repository serves as a central hub for commonly used functions essential across various Ultralytics projects developed in MATLAB. These scripts provide a foundational toolkit designed to assist in the development and research phases of machine learning and data analysis tasks. Explore and utilize these utilities to streamline your workflow and accelerate your projects!

For more information about Ultralytics, our mission, and the innovative work we do in AI, visit our official website: https://www.ultralytics.com.

📘 What is This Repository?

The functions-matlab repository is a curated collection of MATLAB functions frequently employed within the Ultralytics ecosystem. These functions represent the building blocks used across numerous projects, promoting efficient code reuse and maintaining consistency throughout our MATLAB codebase.

📋 Requirements

To effectively use the resources provided in this repository, please ensure you have the following installed:

• MATLAB version R2018a or newer.

📥 Installation

Getting started with these functions is straightforward:

1. Clone this repository to your local machine using Git:

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

2. Add the cloned repository directory to your MATLAB path. This allows MATLAB to locate and execute the functions. Launch MATLAB and run the following command, replacing path_to_cloned_repo with the actual path where you cloned the repository:

   addpath(genpath('path_to_cloned_repo/functions-matlab'))
   % Example: addpath(genpath('/Users/username/Documents/MATLAB/functions-matlab'))
   

   For more details on managing the MATLAB path, see the official MathWorks documentation.

🧰 How to Use

Once the repository is added to your MATLAB path, you can call any function directly from your MATLAB scripts or the command window, just like any built-in MATLAB function.

% Example: Compute the Euclidean distance between two 3D points.
distance = fcnrange([0 0 0], [3 4 0]);
disp(distance);

Refer to the specific function's documentation (usually included as comments within the .m file) for details on its usage, inputs, and outputs. Learn more about calling functions in MATLAB.

💡 Contribute

Ultralytics thrives on community collaboration, and we deeply value your contributions! Whether it's reporting bugs, suggesting features, or submitting code changes, your involvement is crucial.

• Reporting Issues: Encounter a bug? Please report it on GitHub Issues.
• Feature Requests: Have an idea for improvement? Share it via GitHub Issues.
• Pull Requests: Want to contribute code? Please read our Contributing Guide first, then submit a Pull Request.
• Feedback: Share your thoughts and experiences by participating in our official Survey.

A heartfelt thank you 🙏 goes out to all our contributors! Your efforts help make Ultralytics tools better for everyone.

📄 License

Ultralytics offers two licensing options to accommodate diverse needs:

• AGPL-3.0 License: Ideal for students, researchers, and enthusiasts passionate about open collaboration and knowledge sharing. This OSI-approved open-source license promotes transparency and community involvement. See the LICENSE file for details.
• Enterprise License: Designed for commercial applications, this license permits the seamless integration of Ultralytics software and AI models into commercial products and services, bypassing the copyleft requirements of AGPL-3.0. For commercial use cases, please inquire about an Ultralytics Enterprise License.

📮 Contact

For bug reports or feature suggestions, please use GitHub Issues. For general questions, discussions, and community support, join our Discord server!