search

openvinotoolkit / openvino

OpenVINO™ is an open-source toolkit for optimizing and deploying AI inference
https://docs.openvino.ai
Apache License 2.0
6.83k stars 2.18k forks source link

[Good First Issue][Docs]: Expand Python wheels developer documentation #22017

Open p-wysocki opened 8 months ago

p-wysocki commented 8 months ago

Context

Some open source contributors expressed concerns about Python documentation lacking a guide about Python wheels. We're working hard on creating a thriving community, and part of that is developing our documentation as well.

What needs to be done?

Expand Python build docs with a section about Python wheels. The section should roughly contain information about:

  1. What are Python wheels and what you can use them for - you can mention, for example, PyPI OpenVINO distribution: https://pypi.org/project/openvino/#files

  2. There are two wheels in OpenVINO: openvino and openvino-dev. Links to their setup.py files could be useful as well: openvino - https://github.com/openvinotoolkit/openvino/tree/master/src/bindings/python/wheel/setup.py openvino-dev - https://github.com/openvinotoolkit/openvino/blob/master/tools/openvino_dev/setup.py

  3. How to build Python wheels when building the project The build cmake command has to contain -DENABLE_PYTHON=ON and -DENABLE_WHEEL=ON.

  4. Where to find the wheels They should be located under openvino_install_dir/tools.

  5. How development with wheels differs from development using PYTHONPATH set to OpenVINO directories.

  6. ??? - use your creativity, include as much or as little information as you believe is needed for a developer documentation.

These 6 points are not set in stone - if you believe some information is not needed, or something needs mentioning that I didn't think about, add it! It's your own contribution.

Example Pull Requests

You can browse other docs files in Python module for inspiration.

Resources

Contact points

@p-wysocki @jiwaszki @akuporos

Ticket

N/A

ArionDas commented 8 months ago

Hey @p-wysocki ... I have gone through the docs for contributing to the project. I am interested to work on this issue and contribute towards the OPENVINO software. Looking forward to hearing from you soon.

p-wysocki commented 8 months ago

Hello @ArionDas, that's great to hear! I assigned you, please let us know if you have any questions. :)

p-wysocki commented 8 months ago

Hello @ArionDas, can we help you with anything?

ArionDas commented 7 months ago

yeah sure, Actually, I'm a bit busy for the last few days for a tech fest & solution challenge hackathon, I'll get into the issue once it's done...

tonguegrease commented 7 months ago

Hey, is this issue still open? I'd like to contribute to it!

p-wysocki commented 7 months ago

Hello @tonguegrease, since @ArionDas's reply has been 2 weeks ago and there's no changes linked, let's reassign it to you. :) Thanks for taking a look, please let us know if you have any questions!

ArionDas commented 7 months ago

@p-wysocki really sorry, for not being able to help out this time I was into a lot of hackathons & projects

All the best @tonguegrease

mlukasze commented 7 months ago

no worries @ArionDas we will have more tickets to work very soon, and for now - all best with your projects and good luck on hackatons! :)

tonguegrease commented 7 months ago

I uploaded the Python wheels guide, but I'm not too sure if I uploaded it correctly. This is one of my first contributions and I'm still learning how to navigate GitHub. If there is anything I messed up please let me know and I will fix it accordingly. Thank you.

mlukasze commented 7 months ago

hey @tonguegrease you merged a PR to your own master you can revert this PR and edit it to aim for OpenVINO master - Github will help you, yet take a moment to double check where PR is pointing to.

p-wysocki commented 6 months ago

Hello @tonguegrease, are you still working on this or can we reassign it? Do you need help with anything?

tonguegrease commented 6 months ago

Hey, sorry I was busy with other work. I am still currently working on it, I have a good draft of the guide which I will review tonight and make a PR once it's ready. I don't think I have any questions at the moment.

p-wysocki commented 6 months ago

Hi @tonguegrease, please let us know if you have any questions regarding the docs. :)

suparna-here-123 commented 6 months ago

I am a first-time contributor and would love to help!

suparna-here-123 commented 6 months ago

.take

I am a first-time contributor and would love to help!

github-actions[bot] commented 6 months ago

Thanks for being interested in this issue. It looks like this ticket is already assigned to a contributor. Please communicate with the assigned contributor to confirm the status of the issue.

suparna-here-123 commented 6 months ago

Hey, sorry I was busy with other work. I am still currently working on it, I have a good draft of the guide which I will review tonight and make a PR once it's ready. I don't think I have any questions at the moment.

Hello, it seems that this issue has been assigned to you. In case you are unable to work on it and the issue stands open, I would love to step in! Please lmk ASAP! Cheers!

p-wysocki commented 5 months ago

Hello @suparna-here-123, are you still working on this? Is there anything we could help you with?

jagadeeshmadinni commented 1 week ago

.take

github-actions[bot] commented 1 week ago

Thank you for looking into this issue! Please let us know if you have any questions or require any help.