Implement a CI Pipeline to build an executable for Webcam or Gradio demos

[riacheruvu]

Description

Implement Continuous Integration (CI) pipeline to build an executable (exe) for a webcam or Gradio demo. This feature will automate the build process, ensuring that the demo is consistently packaged and ready for deployment.

This project will involve Python programming; basic experience with CI tools like GitHub Actions, Jenkins, or GitLab CI is beneficial. To learn more about the OpenVINO toolkit, visit the documentation here.

Steps:

1. Set Up CI Pipeline:

   • Explore our existing CI Pipeline and reach out with any questions.
   • Create a pipeline that automates the build process for the webcam or Gradio demo.

2. Build Executable:

   • Configure the pipeline to compile the demo into an executable file.
   • Ensure the build process includes all necessary dependencies and resources.
   • Implement auto-release of the built exes.

3. Testing and Validation:

   • Add steps to the pipeline to run tests and validate the build.
   • Ensure the executable functions correctly and meets performance requirements.

4. Documentation:

   • Provide clear and detailed documentation for setting up and running the CI pipeline.
   • Include comments in the pipeline configuration to explain key sections and logic.

How to Get Started:

1. Fork the OpenVINO Build Deploy repository.
2. Follow these installation instructions to setup your environment and install the required dependencies for this project.
3. Read Demo Contribution Guide.
4. Build your feature and ensure it meets the requirements specified in the contribution guide.
5. Submit a pull request.

[fractalito]

OpenVINO_Team2 is working on this issue.

[epacheco0210]

Hello! @adrianboguszewski we have some questions on the scope of this issue

• Can we focus first on implementing a pipeline for Webcam only or for Gradio only? as a first viable product?
• On the statement Implement auto-release of the built exes. What does auto-release refers to? should the exe file resulting be added as an asset?
• Add steps to the pipeline to run tests and validate the build. Do you have an example for this step that we can use? what kind of validations are expected from on the pipeline?
• We are planning to use pyinstaller utility to compile the demos, do you have any recommendations on this?
  Thank you!
  @fractalito

[adrianboguszewski]

Hi @epacheco0210

• Yes, select what you prefer
• Uploading to Github releases
• Just to ensure the exe runs (no crashes, no missing libraries)
• I heard it's a solution for that, but I've never used. So experiment :)

[adparrag]

Hello @adrianboguszewski . As Eliana commented, we are trying to create an .exe file using pyinstaller/nuitka. By using demos the file is created and compiled. However, on webcam demos we are facing issues with dependencies related to libraries and multiprocessing.

I was wondering if you could please share a BKM of how you achieved creating the exe on the following demo: demos/hide_your_mess_behind_demo. Because it offers to download the file and directly run.

Regards :)

[adrianboguszewski]

@adparrag Hide Your Mess Behind demo is a JS + Electron demo, so creating exe there is a completely different process than python. And I don't have BKM for python, unfortunately :/

[github-actions]

This issue has been marked because it has been open for 30 days with no activity. It is scheduled to close in 14 days.

[github-actions]

This issue has been marked because it has been open for 30 days with no activity. It is scheduled to close in 14 days.