Skip to content

Latest commit

 

History

History
120 lines (75 loc) · 3.95 KB

community_projects.md

File metadata and controls

120 lines (75 loc) · 3.95 KB

How to Add a Community Project

This guide will walk you through creating and structuring your community project in the repository.

1. Run the Clip Appliacation

Ensure your environment is set up properly by following the repository instructions and successfully running the clip application. This step verifies your setup.

2. Review the Clip Application Documentation

Familiarize yourself with the Clip Application by reading the documentation here.

3. Create Your Project Directory

Navigate to the community_projects folder and create a directory for your project:

cd community_projects
mkdir <your_project_name>
cd <your_project_name>

4. Copy the Template Example

Copy the contents of the template example to your project directory:

cp ../template_example/* .

Using Clip Application as a Template

The following sections explain how to build your project based on the existing Clip Application

Modify the Callback Class

  1. Update the callback class, which inherits from app_callback_class.
  2. Add the necessary members and methods to customize your application's behavior.

Define the Callback Function

  1. Define a callback function.
  2. This function will handle data from the pipeline and can include your custom logic.

Modify the Main Function

  1. Update the main function to initialize and run your application.

This structure ensures your project can run as a standalone script.

Adding New Networks and Post-Processes

We are working on a "Community Model Zoo" to allow users to share models and post-processes on our servers. Meanwhile, follow these steps:

  1. Save your HEF file on a file-sharing service like Google Drive.
  2. Provide a download_resources.sh script to automate the download.
  3. If you develop a new post-process:
    • Add the necessary code and a compilation script.
    • Refer to the Hailo Apps Infra repository for guidance on creating and compiling new post-processes.

Update Project Files

See the template example README.md for guidance on updating your project files.

Pull Requests (PRs)

To contribute your project or improvements:

  1. Submit a PR to the dev branch of the repository.
  2. Your code should remain within your community_projects/<your_project_name> directory. PRs modifying core code will be rejected.
  3. If you must alter core code for your project:
    • Copy the relevant code into your directory and modify it as needed.
    • Alternatively, suggest manual edits in your instructions.
    • Be aware: This approach may cause compatibility issues in future releases due to lack of backward compatibility. Breaking your code.

Suggestions for improving the core codebase are welcome. However, they must be generic, well-tested, and adaptable to multiple platforms. If you identify missing functionality in our framework, you are welcome to implement it in your project directory. Exceptional features or common functions might be integrated into our core codebase. Important: Code added to the core must meet these requirements:

  • Thoroughly tested and verified.
  • Generic and adaptable to multiple platforms.

By adhering to these guidelines, you help maintain the repository's stability and enable better integration of your work.

Important Guidelines

Do Not Add Binary Files

  • Avoid adding non-code files (e.g., images, HEFs, videos) directly to the repository.
  • Use a download_resources.sh script to fetch these files from external sources like Google Drive.
  • For Model Zoo HEFs, download them directly from Hailo's servers.

Code of Conduct

We are committed to fostering a welcoming and inclusive community. Please ensure that your contributions adhere to the following guidelines:

  • Use clean and non-offensive language.
  • Be respectful and considerate of others.
  • Avoid any form of harassment or discrimination.