search

kubeflow / katib

Automated Machine Learning on Kubernetes
https://www.kubeflow.org/docs/components/katib
Apache License 2.0
1.51k stars 442 forks source link

[SDK] Generate Docs for Katib and Training Operator SDKs #2081

Open andreyvelich opened 1 year ago

andreyvelich commented 1 year ago

Currently, the Katib Client doc is outdated as I mentioned in this PR: https://github.com/kubeflow/katib/pull/2075. Each API in the Katib Client has the appropriate docstring. We should automate doc creation based on that description.

This issue is also applied for the Training Client.

We need to add documentation on how to use KatibClient outside of Kubernetes cluster using Service Account token: https://github.com/kubeflow/katib/issues/2046#issuecomment-1691659428

/area sdk

Love this feature? Give it a 👍 We prioritize the features with the most 👍

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

andreyvelich commented 1 year ago

/lifecycle frozen

andreyvelich commented 8 months ago

/area gsoc

carrycooldude commented 8 months ago

Hey @andreyvelich , I am Kartikey and I wanted to partipcate in upcoming GSOC and previously I contributed to Google's TFJS project too in the area of WebAssembly where I contributed to wasm-backend PR and added kernel to the backend.

UditNayak commented 8 months ago

Hi @andreyvelich I'm Udit, and I'm excited about contributing to this GSoC project! I'm keen on working on this issue and look forward to contributing to its development.

tenzen-y commented 8 months ago

@carrycooldude @UditNayak Hi, everyone. Thank you for your interest in the kubeflow GSoC project. We (mentors) plan to hold a dedicated community meeting for the GSoC candidates.

Please join the kubeflow slack workspace to receive some information about GSoC.

carrycooldude commented 8 months ago

@carrycooldude @UditNayak Hi, everyone. Thank you for your interest in the kubeflow GSoC project. We (mentors) plan to hold a dedicated community meeting for the GSoC candidates.

Please join the kubeflow slack workspace to receive some information about GSoC.

In which channel I can join , I already join katib

andreyvelich commented 8 months ago

@carrycooldude @UditNayak Please join #gsoc-participants channel for GSoC announcements/questions.

carrycooldude commented 8 months ago

@carrycooldude @UditNayak Please join #gsoc-participants channel for GSoC announcements/questions.

Joined ✅

shivas1516 commented 8 months ago

Hey @andreyvelich

I'm SIVASUBRAMANIAM, a pre-final year student pursuing B.Tech in AI, eager to contribute to GSoC and enhance Kubeflow. With experience in Kubeflow components and proficiency in Tensorflow, Kubernetes, and documentation generation using Python libraries, I'm excited about Project 7 that match with my skills and difficult level. Any guidance for a successful application process would be greatly appreciated. Looking forward to collaborating during GSoC and beyond to advance mutually in AI and MLOps.

andreyvelich commented 8 months ago

Nice to meet you @shivas1516! Please join #gsoc-participants Slack channel for GSoC announcements/questions.

shivas1516 commented 8 months ago

Thank you for your attention and response to this matter. I want to inform you that I have already joined.

jdcfd commented 8 months ago

Hello @andreyvelich , I am interested in this issue in the context of GSOC. I have already joined the #gsoc-participants channel. I have programming experience in scientific applications, but not much on automatic generation of docs. I would like to learn more about the process of generating documentation form code/docstrings.

I couldn't join the last AutoML meeting, but I watched the recording and there was some discussion on this topic. I seems like there is no final consensus on where the auto-generated docs would live. Would the GSOC project involve identifying a platform where to put the documentation (someone mentioned readthedocs and Hugo), or more like figuring out how to get the documentation from docstrings onto the current documentation site?

Also, have you already been trying out any automatic documentation generation tools? Is it part of the project to research different tools so we can decide on which one to use or is there some idea on what tools to use already to generate the documentation?

Thanks, -JD

andreyvelich commented 8 months ago

Hi @jdcfd, thank you for your interest working on that project!

Would the GSOC project involve identifying a platform where to put the documentation (someone mentioned readthedocs and Hugo), or more like figuring out how to get the documentation from docstrings onto the current documentation site?

I think, during GSoC we should figure out a way to publish API documentation in kubeflow.org For example, HuggingFace publishes there API documentation to their docs: https://huggingface.co/docs/transformers/v4.38.2/en/main_classes/trainer#api-reference%20][%20transformers.Trainer

Also, have you already been trying out any automatic documentation generation tools?

Not for Katib and Training Operator yet. We need to investigate what projects are doing (e.g. PyTorch, HuggingFace) and implement similar to our SDKs. For example, Kubeflow Pipelines publish their SDK docs here: https://kubeflow-pipelines.readthedocs.io/en/master/, outside of kubeflow.org which might confuse users.

jdcfd commented 8 months ago

Aaah, interesting. Thanks for clarifying @andreyvelich . I agree that the ideal scenario would be to have everything in one place.

jiduyuting commented 7 months ago

Sorry,I'm jiduyuting, I'm interesting in this project and want to do something for this project,but I can't join in #gsoc-participants,can anyone tell me the reason,thanks very much!!!

andreyvelich commented 7 months ago

Sorry,I'm jiduyuting, I'm interesting in this project and want to do something for this project,but I can't join in #gsoc-participants,can anyone tell me the reason,thanks very much!!!

@jiduyuting Please follow this guide to join Kubeflow Slack: https://www.kubeflow.org/docs/about/community/#kubeflow-slack

andreyvelich commented 5 months ago

/assign @shivas1516