Enhanced Exception Handling Testing Documentation

[gchhablani]

Project Title: Enhanced Exception Handling Testing Documentation

Description: This project is dedicated to elevating the overall user experience on EvalAI by implementing robust exception handling mechanisms, strengthening the suite of test cases, and enhancing the comprehensiveness of documentation.

This project aims to significantly contribute to EvalAI's reliability, user-friendliness, and developer-friendliness. The deliverables below collectively contribute to a more stable and user-centric EvalAI experience.

Deliverable:

• Improved Test Coverage and Cases:
  • Identify and address areas with low code coverage to ensure a comprehensive testing suite.
  • Focus on key components that are critical to the functioning of EvalAI, enhancing their test coverage.
  • Develop tests for frequently used APIs, especially those accessed through EvalAI CLI, to ensure their reliability.
  • Add tests for code-upload workers and enhance testing for other components like submissions and remote workers.
    (Optional) Integrate Postman API testing during the EvalAI build process to fortify the backend and ensure resilience.
• Improved Documentation and Tutorials:
  • Enhance API documentation on EvalAI, providing detailed summaries of API functionalities and troubleshooting tips.
  • Create a comprehensive tutorial for organizers unfamiliar with AWS, guiding them on setting up infrastructure for their challenges.
  • Develop a detailed FAQ page based on common questions received by EvalAI, providing quick and easy-to-understand answers/solutions.
  • Create detailed documentation on how auto-scaling functions for ECS, EKS, and EC2, offering insights into host-end cost-saving options.
  • Improve documentation on various challenge phases and submission options. For example, explaining the visibility of leaderboards, submissions, and challenge phases, along with preference order details.
• Improved Error Handling and Messages:
  • Conduct a thorough analysis of the codebase to identify potential breakage points.
  • Enhance error messages throughout EvalAI, providing clearer insights into issues for faster resolution.
  • Improve exception handling in AWS utilities, eliminating silent errors and providing verbose messages for quick error correction.
  • Ensure all errors are returned in API responses with proper reasoning, facilitating better understanding and resolution.

Mentor: @gautamjajoo , @RishabhJain2018

Skills: Django, Markdown, Python

Skill Level: Easy

Get started: Try to fix some issues in EvalAI (note that there are some issues labeled with GSoC-2024).

Important Links:

• EvalAI Website: eval.ai
• EvalAI Github repository: Cloud-CV/EvalAI
• EvalAI Docs: http://evalai.readthedocs.io/en/latest
• GSoC Proposal Template: Cloud-CV/GSoC-Ideas/wiki/GSOC-2020-Proposal-Template
• Gitter Channel: gitter.im/Cloud-CV
• Mailing list: groups.google.com/forum/#!forum/cloudcv

[solvibrain]

Hey @gchhablani ,
I am new in Open Source Contribution. Will you , Please help me , by suggesting me the efficient way to go through code base. So , It will help me Understanding the Codebase .

[KimVianney]

Hello @gchhablani @RishabhJain2018, I am interested in taking on this issue. I have just set up my environment

[sp-mujuni]

Hello @gchhablani @RishabhJain2018, I am interested in taking on this issue.

[AishwaryJain07]

Hey @gautamjajoo @RishabhJain2018 @gchhablani .
I'm interested in getting on with this issue in this Summer of codes! and further on.

[aujlasant-gmail]

I'm interasted in this project. Please assign me this issue.

[Dawnliving]

Hi, @gchhablani @gautamjajoo , @RishabhJain2018 I'm interested in this project, and wanna be a participant of this community and Gsoc.

[Akshat453]

Hey,@gautamjajoo , @RishabhJain2018. I am interested in working on this project.Please assign me this issue

[Shadowsweep]

Hi @gchhablani , @RishabhJain2018 ,

Dear Sir,
My name is Utkarsh gupta and i am a Django Developer . I had worked on projects using REST API Framework , and frontend using React , html, css . I am intrested in contributing the project and i also tried to clone the repository but the docker gave an error. I would like i you could help me out to find solution for that so that i could contribute .
Here's my git repo - https://github.com/Shadowsweep
And LinkedIn - https://www.linkedin.com/in/utkarsh-gupta-075908223/
Portfolio for projects reference - https://portfolio-utk.vercel.app/

[Antoniocolapso]

Interested for the project.

A little bit about me :

I'm Omm Prakash Sahoo from IIT Bhilai, 3rd year b.tech. i recently become ML guy after doing CP and dev in my first 2 years.Was ICPC regionalist expert at CodeForces done decent amount of DEVoPs, Developed both Web and android apps, topped in SystemDesign and ML course at our college, built LIP-Reader (predicting sentence only by lip movement), was lead of INTER-IIT Tech meet team for Adobe behaviour simulation challenge in which we developed 2 LLMs to ease the process of posting new content for marketing for companies in every segment and a lots of interesting works.

After achieving my personal goals in CP in first 2 years now i want to finally contribute to real-world problems.Coz have been member of GDSC, OpenLake(Club for Open Source enthusiasts at IIT Bhilai) and Co-ordinator of Ingenuity (CP club).

Here is my resume link : https://drive.google.com/file/d/1LbGBW9veH75x7IqABSk9ui03JIzZv7cV/view?usp=drive_link

I will be there to solve it soon.

[negiayushi]

Hi ,
I'm Ayushi negi , I'm currently in my 3rd year of B.E program in cse , this is my first time participating in Google open source . I want to learn and I'm interested contributing in real life projects.

[Jaishree2310]

Hi, @gchhablani @RishabhJain2018 @gautamjajoo & EvalAI Community!
I’m Jaishree Singh and I’m currently in the 4th year of the Computer Science Engineering degree
at Mumbai University (Mumbai, India).
I am familiar with technologies/ tools like Python, HTML, CSS, Javascript, C, Java, SQL,
Node.js, React.js, Vue.js, Django, docker, Angularjs, aws, Figma, Github, and Firebase.
My background in software development, particularly Django and Python, fuels my passion for building user-friendly applications. I'm excited to leverage this experience on the project, "Enhanced Exception Handling Testing Documentation" to improve EvalAI's reliability and user experience. 😊

[franklin23-cmr]

HI ! i'm franklin from CAMEROON,
Student of the polythenic school Yaounde,cameroon, 5th year
this is my first time to participate in google open source
I'm quick to adapt and a good worker
I'm not fluent in English, but I'm learning every day. I hope to take part in this challenge, first and foremost for myself!
I hope to be selected
Merci ! et Bonne journee