Browse Poster Wiki: 2022 Poster Award Winners, Awards Ceremony (Watch Recording from minute marker 1630), Posters by 2022 HPCC Systems Interns, Posters by Academic Partners, Poster Judges, About Virtual Judging, 2022 Poster Contest Home Page, Poster Contest Previous Years

Shivam Singhal is a Masters student studying Software Engineering at the University of Oulu in Finland.

Shivam's intern project was suggested by the leader of our Machine Learning Library, Roger Dev. While we already have ECL Code Document Generator, it required a refresh and update. Shivam's work involved evaluating the existing features, looking at potential weaknesses with a view to suggesting and implementing key improvements. Additional deliverables included providing testing documentation and a supportable GitHub repository. While this work will be helpful to those providing and using the HPCC Systems Machine Learning bundles. it will allow any ECL developer to generate user documentation from their code.

As well as the resources included here, read Shivam's intern blog journal which includes a more in depth look of his work.

Poster Abstract

The ECL Doc Generator is a important project in the HPCC Systems Ecosystem because it generates the documentation for the Machine Learning Bundles. During my internship I worked on updating the availability of the package as a pypi module, updated the designs, rebranded the docs with new logos, added new features like readme addition as well improving visibility and code quality.

Presentation

In this Video Recording, Shivam provides a tour and explanation of his poster content.

ECL Code Document Generator Improvements

Click on the poster for a larger image.