Enhance Dependency Management and Documentation for Ianvs

[FuryMartin]

Background

Ianvs is currently grappling with significant dependency management challenges. It lacks a robust system to handle updates and ensure compatibility. As Python versions, dependency libraries, and Ianvs features continuously evolve, many existing examples fail to run, resulting in a surge of inquiries in the Issues section. Moreover, new PRs are often merged without being tested against historical examples, making it difficult to guarantee the functionality of past features through manual Code Review alone. There is an urgent need for a more comprehensive CI testing framework to maintain the usability of Ianvs features as the project progresses. Additionally, the online documentation is outdated, which can be quite confusing for new users.

Expected Outcome

Basic Task:

• Update the Contributing Guide
  • Clearly document the dependency relationship between ianvs and sedna in the Contributing Guide. Explain how to resolve this dependency, and provide the rationale behind it.
• Develop a New Quick Start Example with Comprehensive Documentation
  • Refine the existing example examples/cloud-edge-collaborative-inference-for-llm to fully demonstrate the usage of ianvs. This example should illustrate the setup of each module, highlight potential pitfalls, and serve as a blueprint for others to follow.
  • The example must be accompanied by comprehensive documentation.
• Update Documentation for Other Paradigm Usage:
  • Paradigms: SingleTaskLearning, LifeLongLearning
  • Examples: examples/llm_simple_qa, examples/robot/lifelong_learning_bench
  • Ensure that the examples for these paradigms are runnable and are supported by detailed documentation.

Advance Task:

• Ensure other old examples are runnable
• An implementation of CI/CD that automatically verifies whether existing examples are runnable.

Suggested Skills

• Dependency Management: Proficiency in Python and CI/CD pipelines.
• Documentation: Experience in writing clear and comprehensive technical documentation.
• Testing: Knowledge of automated testing frameworks and practices to ensure backward compatibility.
• Collaboration: Ability to coordinate changes across multiple repositories (Ianvs and Sedna) and work with the community to address issues and integrate feedback.

[AryanNanda17]

Hello @FuryMartin,

I am interested in this project. My previous experience includes a successful GSoC project with BeagleBoard. Reference
I am familiar with AI/ML. Reference
I have Python experience as well. Reference1, Reference2
I have documentation experience with Sphinx. Reference. I have also made a few documentation PRs in ianvs, which are currently unmerged: #174, #180, and #181.
I have experienced version conflicts in ianvs and created PRs resolving these issues in the pcb-aoi dataset. Reference
I am familiar with CI/CD pipelines. Reference

-> Next Steps:

• To address the version conflicts present in the pcb-aoi example, I have submitted a few PRs. I will work on verifying other examples as well. If they are not runnable, I will collaborate with the community to resolve the errors and submit corrections through additional PRs.
• I will also familiarize myself with the cloud-edge-collaborative-inference-for-LLM example.

Please let me know if I am on the right track.
Looking forward to discuss more on this project in future meetings.

Thanks and Regards,
Aryan Nanda

[ggold7046]

Hi @FuryMartin, could you tell me the last date for application to this mentorship ? Could you please let me know the selection criteria and selection date for the same ?

[AryanNanda17]

Hello @MooreZheng
Kubeedge Bot closed this issue automatically. But it should still be open.
#182 solves the dependency conflicts in singletask_learning/pcb-aoi example but there are others parts of this project as well which are equally important.
Thanks

[MooreZheng]

Hello @MooreZheng Kubeedge Bot closed this issue automatically. But it should still be open. #182 solves the dependency conflicts in singletask_learning/pcb-aoi example but there are others parts of this project as well which are equally important. Thanks

Sure. The issue is now re-open.