Texera / texera

Collaborative Machine-Learning-Centric Data Analytics Using Workflows
https://texera.github.io
Apache License 2.0
163 stars 72 forks source link

Enhancing Report Generation by Adding Operator Json and Comments Section #2807

Closed xudongwu-0 closed 2 months ago

xudongwu-0 commented 2 months ago

This PR enhances the report generation functionality by adding Operator JSON and Comments Section. This PR is a continuation and enhancement of the previous PR, which can be found at the following link: https://github.com/Texera/texera/pull/2770 and https://github.com/Texera/texera/pull/2792

  1. The file was modified in this PR: ReportGenerationService

retrieveOperatorInfoReport(operatorId: string,allResults: { operatorId: string; html: string }[]): Implements a 'Toggle Detail' button beneath each operator, allowing users to expand and view the operator's corresponding JSON, formatted using a JSON viewer. Adds a comments section below each operator, enabling users to leave their own comments. It can be use

  1. generateReportAsHtml(workflowSnapshot: string, allResults: string[], workflowName: string):

Generates a comprehensive HTML file containing the workflow snapsho, all operator results, operator details, and comments section ,then triggers a download of the report. add 'Download Workflow JSON' button, allowing user download the whole JSON file directly from the report.

Operation Process: Click the button below to generate the report with detailed operator results and the workflow snapshot. image

Here is a part of the example report. image image

chenlica commented 2 months ago

Now the PR looks good.