Skip to content

Commit

Permalink
fixed the images in final_report.qmd
Browse files Browse the repository at this point in the history
  • Loading branch information
John Shiu committed Jun 22, 2024
1 parent 6036458 commit 4488e04
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 31 deletions.
Binary file added report/docs/img/checklist_sample.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added report/docs/img/proposed_system_overview.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added report/docs/img/test_evaluation_report_sample.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added report/docs/img/test_spec_sample.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 27 additions & 27 deletions report/docs/report/final_report.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ <h4 class="anchored" data-anchor-id="how-to-use-the-product">How to use the prod
</section>
<section id="system-design" class="level4">
<h4 class="anchored" data-anchor-id="system-design">System Design</h4>
<p>(FIXME To be revised) <img src="img/proposed_system_overview.png" class="img-fluid" alt="image"></p>
<p>(FIXME To be revised) <img src="../img/proposed_system_overview.png" class="img-fluid" alt="image"></p>
<p>The design of our package follows object-oriented and SOLID principles, which is fully modularity. Users can easily switch between different prompts, models, and checklists, which facilitates code reusability and collaboration to extend its functionality.</p>
<p>There are five components in the system of our package:</p>
<ol type="1">
Expand Down Expand Up @@ -365,7 +365,7 @@ <h4 class="anchored" data-anchor-id="checklist-design">Checklist Design</h4>
</tr>
</tbody>
</table>
<p>(FIXME To be revised) <img src="img/checklist_sample.png" width="600"></p>
<p>(FIXME To be revised) <img src="../img/checklist_sample.png" width="600"></p>
</section>
<section id="artifacts" class="level4">
<h4 class="anchored" data-anchor-id="artifacts">Artifacts</h4>
Expand All @@ -379,12 +379,12 @@ <h4 class="anchored" data-anchor-id="artifacts">Artifacts</h4>
<li><strong>Evaluation Report</strong></li>
</ol>
<p>This report presents structured evaluation results of ML projects, which includes a detailed breakdown of completeness scores and reasons for each score.</p>
<p>(FIXME To be revised) <img src="img/test_evaluation_report_sample.png" width="600"></p>
<p>(FIXME To be revised) <img src="../img/test_evaluation_report_sample.png" width="600"></p>
<ol start="3" type="1">
<li><strong>Test Specification Script</strong></li>
</ol>
<p>Generated test specifications are stored as Python scripts.</p>
<p>(FIXME To be revised) <img src="img/test_spec_sample.png" width="600"></p>
<p>(FIXME To be revised) <img src="../img/test_spec_sample.png" width="600"></p>
</section>
</section>
<section id="evaluation-results" class="level3">
Expand All @@ -402,7 +402,7 @@ <h3 class="anchored" data-anchor-id="evaluation-results">Evaluation Results</h3>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>gt <span class="op">=</span> pd.read_csv(<span class="st">'../data/processed/ground_truth.csv'</span>)</span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a>gt</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</details>
<div class="cell-output cell-output-display" data-execution_count="2">
<div class="cell-output cell-output-display" data-execution_count="1">
<div>


Expand Down Expand Up @@ -540,26 +540,26 @@ <h3 class="anchored" data-anchor-id="evaluation-results">Evaluation Results</h3>
<span id="cb2-52"><a href="#cb2-52" aria-hidden="true" tabindex="-1"></a> titleFontSize<span class="op">=</span><span class="dv">12</span></span>
<span id="cb2-53"><a href="#cb2-53" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</details>
<div class="cell-output cell-output-display" data-execution_count="3">
<div class="cell-output cell-output-display" data-execution_count="2">

<style>
#altair-viz-783ec552a7aa4549add82947d5eefb4b.vega-embed {
#altair-viz-2e51836bde5f498c91a72176f891a9a9.vega-embed {
width: 100%;
display: flex;
}

#altair-viz-783ec552a7aa4549add82947d5eefb4b.vega-embed details,
#altair-viz-783ec552a7aa4549add82947d5eefb4b.vega-embed details summary {
#altair-viz-2e51836bde5f498c91a72176f891a9a9.vega-embed details,
#altair-viz-2e51836bde5f498c91a72176f891a9a9.vega-embed details summary {
position: relative;
}
</style>
<div id="altair-viz-783ec552a7aa4549add82947d5eefb4b"></div>
<div id="altair-viz-2e51836bde5f498c91a72176f891a9a9"></div>
<script type="text/javascript">
var VEGA_DEBUG = (typeof VEGA_DEBUG == "undefined") ? {} : VEGA_DEBUG;
(function(spec, embedOpt){
let outputDiv = document.currentScript.previousElementSibling;
if (outputDiv.id !== "altair-viz-783ec552a7aa4549add82947d5eefb4b") {
outputDiv = document.getElementById("altair-viz-783ec552a7aa4549add82947d5eefb4b");
if (outputDiv.id !== "altair-viz-2e51836bde5f498c91a72176f891a9a9") {
outputDiv = document.getElementById("altair-viz-2e51836bde5f498c91a72176f891a9a9");
}
const paths = {
"vega": "https://cdn.jsdelivr.net/npm/vega@5?noext",
Expand Down Expand Up @@ -631,7 +631,7 @@ <h3 class="anchored" data-anchor-id="evaluation-results">Evaluation Results</h3>
<span id="cb3-13"><a href="#cb3-13" aria-hidden="true" tabindex="-1"></a>contingency_table.index.names <span class="op">=</span> [<span class="st">'Repository'</span>, <span class="st">'Checklist Item'</span>, <span class="st">'Ground Truth'</span>]</span>
<span id="cb3-14"><a href="#cb3-14" aria-hidden="true" tabindex="-1"></a>contingency_table.sort_index(level<span class="op">=</span>[<span class="dv">0</span>, <span class="dv">2</span>])</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</details>
<div class="cell-output cell-output-display" data-execution_count="4">
<div class="cell-output cell-output-display" data-execution_count="3">
<div>


Expand Down Expand Up @@ -816,26 +816,26 @@ <h3 class="anchored" data-anchor-id="evaluation-results">Evaluation Results</h3>
<span id="cb4-42"><a href="#cb4-42" aria-hidden="true" tabindex="-1"></a> title<span class="op">=</span><span class="st">"30 Runs on Openja's Repositories for each Checklist Item"</span></span>
<span id="cb4-43"><a href="#cb4-43" aria-hidden="true" tabindex="-1"></a>) </span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</details>
<div class="cell-output cell-output-display" data-execution_count="5">
<div class="cell-output cell-output-display" data-execution_count="4">

<style>
#altair-viz-7559d464dff34829a5b9bf0719974be8.vega-embed {
#altair-viz-76f736c12da445dbb517ce132d68e98d.vega-embed {
width: 100%;
display: flex;
}

#altair-viz-7559d464dff34829a5b9bf0719974be8.vega-embed details,
#altair-viz-7559d464dff34829a5b9bf0719974be8.vega-embed details summary {
#altair-viz-76f736c12da445dbb517ce132d68e98d.vega-embed details,
#altair-viz-76f736c12da445dbb517ce132d68e98d.vega-embed details summary {
position: relative;
}
</style>
<div id="altair-viz-7559d464dff34829a5b9bf0719974be8"></div>
<div id="altair-viz-76f736c12da445dbb517ce132d68e98d"></div>
<script type="text/javascript">
var VEGA_DEBUG = (typeof VEGA_DEBUG == "undefined") ? {} : VEGA_DEBUG;
(function(spec, embedOpt){
let outputDiv = document.currentScript.previousElementSibling;
if (outputDiv.id !== "altair-viz-7559d464dff34829a5b9bf0719974be8") {
outputDiv = document.getElementById("altair-viz-7559d464dff34829a5b9bf0719974be8");
if (outputDiv.id !== "altair-viz-76f736c12da445dbb517ce132d68e98d") {
outputDiv = document.getElementById("altair-viz-76f736c12da445dbb517ce132d68e98d");
}
const paths = {
"vega": "https://cdn.jsdelivr.net/npm/vega@5?noext",
Expand Down Expand Up @@ -960,26 +960,26 @@ <h4 class="anchored" data-anchor-id="comparison-of-gpt-3.5-turbo-and-gpt-4o">Com
<span id="cb5-55"><a href="#cb5-55" aria-hidden="true" tabindex="-1"></a> titleFontSize<span class="op">=</span><span class="dv">12</span></span>
<span id="cb5-56"><a href="#cb5-56" aria-hidden="true" tabindex="-1"></a>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</details>
<div class="cell-output cell-output-display" data-execution_count="6">
<div class="cell-output cell-output-display" data-execution_count="5">

<style>
#altair-viz-9c6dbe52484a41068029b5ce3c9b4b16.vega-embed {
#altair-viz-7bb302ef75b745b78e688e47a21a7c6a.vega-embed {
width: 100%;
display: flex;
}

#altair-viz-9c6dbe52484a41068029b5ce3c9b4b16.vega-embed details,
#altair-viz-9c6dbe52484a41068029b5ce3c9b4b16.vega-embed details summary {
#altair-viz-7bb302ef75b745b78e688e47a21a7c6a.vega-embed details,
#altair-viz-7bb302ef75b745b78e688e47a21a7c6a.vega-embed details summary {
position: relative;
}
</style>
<div id="altair-viz-9c6dbe52484a41068029b5ce3c9b4b16"></div>
<div id="altair-viz-7bb302ef75b745b78e688e47a21a7c6a"></div>
<script type="text/javascript">
var VEGA_DEBUG = (typeof VEGA_DEBUG == "undefined") ? {} : VEGA_DEBUG;
(function(spec, embedOpt){
let outputDiv = document.currentScript.previousElementSibling;
if (outputDiv.id !== "altair-viz-9c6dbe52484a41068029b5ce3c9b4b16") {
outputDiv = document.getElementById("altair-viz-9c6dbe52484a41068029b5ce3c9b4b16");
if (outputDiv.id !== "altair-viz-7bb302ef75b745b78e688e47a21a7c6a") {
outputDiv = document.getElementById("altair-viz-7bb302ef75b745b78e688e47a21a7c6a");
}
const paths = {
"vega": "https://cdn.jsdelivr.net/npm/vega@5?noext",
Expand Down
8 changes: 4 additions & 4 deletions report/final_report.qmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ By offering it as both CLI tool and API, our product is user-friendly to interac

#### System Design

(FIXME To be revised) ![image](img/proposed_system_overview.png)
(FIXME To be revised) ![image](../img/proposed_system_overview.png)

The design of our package follows object-oriented and SOLID principles, which is fully modularity. Users can easily switch between different prompts, models, and checklists, which facilitates code reusability and collaboration to extend its functionality.

Expand Down Expand Up @@ -128,7 +128,7 @@ Example checklist structure:
| Reference | References for the checklist item, e.g., academic papers |
| Is Evaluator Applicable | Indicates if the checklist item is used during evaluation (0 = No, 1 = Yes) |

(FIXME To be revised) <img src="img/checklist_sample.png" width="600" />
(FIXME To be revised) <img src="../img/checklist_sample.png" width="600" />

#### Artifacts

Expand All @@ -144,13 +144,13 @@ These responses include both LLM evaluation results and process metadata stored

This report presents structured evaluation results of ML projects, which includes a detailed breakdown of completeness scores and reasons for each score.

(FIXME To be revised) <img src="img/test_evaluation_report_sample.png" width="600" />
(FIXME To be revised) <img src="../img/test_evaluation_report_sample.png" width="600" />

3. **Test Specification Script**

Generated test specifications are stored as Python scripts.

(FIXME To be revised) <img src="img/test_spec_sample.png" width="600" />
(FIXME To be revised) <img src="../img/test_spec_sample.png" width="600" />

### Evaluation Results

Expand Down

0 comments on commit 4488e04

Please sign in to comment.