Skip to content

Commit

Permalink
Updates to demo
Browse files Browse the repository at this point in the history
  • Loading branch information
@ciioprof0
ciioprof0 committed Aug 18, 2024
1 parent 79ebced commit 5678718
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 49 deletions.
15 changes: 9 additions & 6 deletions ling508/demos/demo_clex_importer.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@
"# Demonstration of STIX-D's Clex Importer Tool\n",
"\n",
"- Main Project Repository: https://github.com/ciioprof0/stixd\n",
"- Slides & Speaker Notes: https://github.com/ciioprof0/stixd/raw/main/ling508/demos/\n"
"- Slides & Speaker Notes: \n",
" https://github.com/ciioprof0/stixd/raw/main/ling508/demos/\n"
]
},
{
Expand Down Expand Up @@ -458,7 +459,11 @@
},
{
"cell_type": "markdown",
"metadata": {},
"metadata": {
"slideshow": {
"slide_type": "notes"
}
},
"source": [
"**Speaker Notes for the Setup Notebook Environment Slide:**\n",
"Before running the tests, ensure that the necessary packages are installed and the required modules are imported. If running this notebook for the first time, uncomment and execute the provided c`requirements.txt` file to install the necessary dependencies.\n"
Expand All @@ -472,9 +477,7 @@
}
},
"source": [
"### All Test Cases\n",
"\n",
"TODO: Add Bulleted List or Diagram\n"
"### All Test Cases\n"
]
},
{
Expand Down Expand Up @@ -1594,7 +1597,7 @@
}
},
"source": [
"*** Speaker Notes for the Conclusion Slide:***\n",
"**Speaker Notes for the Conclusion Slide:**\n",
"\n",
"In this demonstration, we explored a use case for the Clex Importer tool, which populates the `lexicon` table in the STIX-D Corpus Database with entries from the ACE Common Lexicon (Clex). The project design leverages object-oriented programming principles to create a modular, extensible, and maintainable system, with key modules like `ClexImporter` and `MySQLRepository` facilitating database interactions and lexicon importation. The testing strategy includes unit, integration, and end-to-end tests to ensure the reliability and correctness of the codebase. By executing the Clex Importer tool via the command line interface and web interface, users can seamlessly import Clex entries into the database, supporting ACE-based natural language processing tasks."
]
Expand Down
40 changes: 16 additions & 24 deletions ling508/demos/demo_clex_importer.slides.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7442,7 +7442,8 @@
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<h1 id="Demonstration-of-STIX-D's-Clex-Importer-Tool">Demonstration of STIX-D's Clex Importer Tool<a class="anchor-link" href="#Demonstration-of-STIX-D's-Clex-Importer-Tool"></a></h1><ul>
<li>Main Project Repository: <a href="https://github.com/ciioprof0/stixd">https://github.com/ciioprof0/stixd</a></li>
<li>Slides &amp; Speaker Notes: <a href="https://github.com/ciioprof0/stixd/raw/main/ling508/demos/">https://github.com/ciioprof0/stixd/raw/main/ling508/demos/</a></li>
<li>Slides &amp; Speaker Notes:
<a href="https://github.com/ciioprof0/stixd/raw/main/ling508/demos/">https://github.com/ciioprof0/stixd/raw/main/ling508/demos/</a></li>
</ul>
</div>
</div>
Expand All @@ -7455,8 +7456,7 @@ <h1 id="Demonstration-of-STIX-D's-Clex-Importer-Tool">Demonstration of STIX-D's
<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<p><strong>Speaker Notes for the Title Slide:</strong></p>
<p>Welcome to this demonstration of the Clex Importer tool. The Clex Importer is a utility designed to populate the <code>lexicon</code> table in the STIX-D Corpus Database with entries from the Attempto Controlled English (ACE) common lexicon. ACE is a controlled natural language, enabling precise language processing for applications that require unambiguous interpretation by both humans and machines.</p>
<p>In this demonstration, we will walk through the process of importing the ACE common lexicon into the database. The tool reads the Clex lexicon file, parses its content, and systematically imports the lexical entries into the database. By the end of this demonstration, the <code>lexicon</code> table will be populated with sample entries to support ACE-based natural language processing tasks.</p>
<p>Welcome to this demonstration of the Clex Importer tool.</p>
</div>
</div>
</div>
Expand Down Expand Up @@ -7488,7 +7488,7 @@ <h2 id="Agenda">Agenda<a class="anchor-link" href="#Agenda">¶</a></h2><ol>
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<p><strong>Speaker Notes for the Agenda Slide:</strong></p>
<ul>
<li><p><strong>Introduction</strong>: This slide outlines the key points we'll cover in today's demonstration.</p>
<li><p><strong>Introduction</strong>: The agenda slide outlines the key points we'll cover in today's demonstration.</p>
</li>
<li><p><strong>Background</strong>: We'll provide an overview of the parent STIX-D project.</p>
</li>
Expand Down Expand Up @@ -7701,7 +7701,7 @@ <h3 id="OOP-Principles">OOP Principles<a class="anchor-link" href="#OOP-Principl
</div>
</div>
</div>
</div>
</div><aside class="notes">
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper" tabindex="0">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
Expand All @@ -7719,7 +7719,8 @@ <h3 id="OOP-Principles">OOP Principles<a class="anchor-link" href="#OOP-Principl
</div>
</div>
</div>
</div></section><section>
</div>
</aside></section><section>
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper" tabindex="0">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
Expand Down Expand Up @@ -7933,7 +7934,7 @@ <h3 id="Setup-Notebook-Environment">Setup Notebook Environment<a class="anchor-l
</div>
</div>
</div>
</div>
</div><aside class="notes">
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper" tabindex="0">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
Expand All @@ -7945,14 +7946,15 @@ <h3 id="Setup-Notebook-Environment">Setup Notebook Environment<a class="anchor-l
</div>
</div>
</div>
</div></section></section><section><section>
</div>
</aside></section></section><section><section>
<div class="jp-Cell jp-MarkdownCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper" tabindex="0">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<h3 id="All-Test-Cases">All Test Cases<a class="anchor-link" href="#All-Test-Cases"></a></h3><p>TODO: Add Bulleted List or Diagram</p>
<h3 id="All-Test-Cases">All Test Cases<a class="anchor-link" href="#All-Test-Cases"></a></h3>
</div>
</div>
</div>
Expand Down Expand Up @@ -8909,7 +8911,7 @@ <h3 id="Show-Database-State-After-Code-Execution">Show Database State After Code
</div>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell">
</div></section><section><div class="jp-Cell jp-CodeCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper" tabindex="0">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
Expand Down Expand Up @@ -8991,7 +8993,7 @@ <h3 id="Show-Database-State-After-Code-Execution">Show Database State After Code
</div>
</div>
</div>
</div><div class="jp-Cell jp-CodeCell jp-Notebook-cell">
</div></section><section><div class="jp-Cell jp-CodeCell jp-Notebook-cell">
<div class="jp-Cell-inputWrapper" tabindex="0">
<div class="jp-Collapser jp-InputCollapser jp-Cell-inputCollapser">
</div>
Expand Down Expand Up @@ -9137,18 +9139,8 @@ <h2 id="Conclusion">Conclusion<a class="anchor-link" href="#Conclusion">¶</a></
<li>Use Case</li>
<li>Project Design</li>
<li>Code Interaction with Database</li>
<li>Test Cases<ul>
<li>All Tests</li>
<li>Unit Tests</li>
<li>Integration Tests</li>
<li>End-to-End Tests</li>
</ul>
</li>
<li>Code Execution<ul>
<li>Command Line Interface (in notebook)</li>
<li>Web Interface (not in notebook)</li>
</ul>
</li>
<li>Test Cases</li>
<li>Code Execution</li>
</ol>
</div>
</div>
Expand All @@ -9160,7 +9152,7 @@ <h2 id="Conclusion">Conclusion<a class="anchor-link" href="#Conclusion">¶</a></
</div>
<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<p>*** Speaker Notes for the Conclusion Slide:***</p>
<p><strong>Speaker Notes for the Conclusion Slide:</strong></p>
<p>In this demonstration, we explored a use case for the Clex Importer tool, which populates the <code>lexicon</code> table in the STIX-D Corpus Database with entries from the ACE Common Lexicon (Clex). The project design leverages object-oriented programming principles to create a modular, extensible, and maintainable system, with key modules like <code>ClexImporter</code> and <code>MySQLRepository</code> facilitating database interactions and lexicon importation. The testing strategy includes unit, integration, and end-to-end tests to ensure the reliability and correctness of the codebase. By executing the Clex Importer tool via the command line interface and web interface, users can seamlessly import Clex entries into the database, supporting ACE-based natural language processing tasks.</p>
</div>
</div>
Expand Down
28 changes: 9 additions & 19 deletions ling508/demos/demo_clex_importer_notes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head><meta charset="utf-8"/>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<title>demo_clex_importer</title><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/require.min.js"></script>
<title>demo_clex_importer_notes</title><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.10/require.min.js"></script>
<style type="text/css">
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
Expand Down Expand Up @@ -7518,7 +7518,8 @@
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<h1 id="Demonstration-of-STIX-D's-Clex-Importer-Tool">Demonstration of STIX-D's Clex Importer Tool<a class="anchor-link" href="#Demonstration-of-STIX-D's-Clex-Importer-Tool"></a></h1><ul>
<li>Main Project Repository: <a href="https://github.com/ciioprof0/stixd">https://github.com/ciioprof0/stixd</a></li>
<li>Slides &amp; Speaker Notes: <a href="https://github.com/ciioprof0/stixd/raw/main/ling508/demos/">https://github.com/ciioprof0/stixd/raw/main/ling508/demos/</a></li>
<li>Slides &amp; Speaker Notes:
<a href="https://github.com/ciioprof0/stixd/raw/main/ling508/demos/">https://github.com/ciioprof0/stixd/raw/main/ling508/demos/</a></li>
</ul>
</div>
</div>
Expand All @@ -7531,8 +7532,7 @@ <h1 id="Demonstration-of-STIX-D's-Clex-Importer-Tool">Demonstration of STIX-D's
<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<p><strong>Speaker Notes for the Title Slide:</strong></p>
<p>Welcome to this demonstration of the Clex Importer tool. The Clex Importer is a utility designed to populate the <code>lexicon</code> table in the STIX-D Corpus Database with entries from the Attempto Controlled English (ACE) common lexicon. ACE is a controlled natural language, enabling precise language processing for applications that require unambiguous interpretation by both humans and machines.</p>
<p>In this demonstration, we will walk through the process of importing the ACE common lexicon into the database. The tool reads the Clex lexicon file, parses its content, and systematically imports the lexical entries into the database. By the end of this demonstration, the <code>lexicon</code> table will be populated with sample entries to support ACE-based natural language processing tasks.</p>
<p>Welcome to this demonstration of the Clex Importer tool.</p>
</div>
</div>
</div>
Expand Down Expand Up @@ -7563,7 +7563,7 @@ <h2 id="Agenda">Agenda<a class="anchor-link" href="#Agenda">¶</a></h2><ol>
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<p><strong>Speaker Notes for the Agenda Slide:</strong></p>
<ul>
<li><p><strong>Introduction</strong>: This slide outlines the key points we'll cover in today's demonstration.</p>
<li><p><strong>Introduction</strong>: The agenda slide outlines the key points we'll cover in today's demonstration.</p>
</li>
<li><p><strong>Background</strong>: We'll provide an overview of the parent STIX-D project.</p>
</li>
Expand Down Expand Up @@ -8018,7 +8018,7 @@ <h3 id="Setup-Notebook-Environment">Setup Notebook Environment<a class="anchor-l
</div>
<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<h3 id="All-Test-Cases">All Test Cases<a class="anchor-link" href="#All-Test-Cases"></a></h3><p>TODO: Add Bulleted List or Diagram</p>
<h3 id="All-Test-Cases">All Test Cases<a class="anchor-link" href="#All-Test-Cases"></a></h3>
</div>
</div>
</div>
Expand Down Expand Up @@ -9198,18 +9198,8 @@ <h2 id="Conclusion">Conclusion<a class="anchor-link" href="#Conclusion">¶</a></
<li>Use Case</li>
<li>Project Design</li>
<li>Code Interaction with Database</li>
<li>Test Cases<ul>
<li>All Tests</li>
<li>Unit Tests</li>
<li>Integration Tests</li>
<li>End-to-End Tests</li>
</ul>
</li>
<li>Code Execution<ul>
<li>Command Line Interface (in notebook)</li>
<li>Web Interface (not in notebook)</li>
</ul>
</li>
<li>Test Cases</li>
<li>Code Execution</li>
</ol>
</div>
</div>
Expand All @@ -9221,7 +9211,7 @@ <h2 id="Conclusion">Conclusion<a class="anchor-link" href="#Conclusion">¶</a></
</div>
<div class="jp-InputArea jp-Cell-inputArea"><div class="jp-InputPrompt jp-InputArea-prompt">
</div><div class="jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type="text/markdown">
<p>*** Speaker Notes for the Conclusion Slide:***</p>
<p><strong>Speaker Notes for the Conclusion Slide:</strong></p>
<p>In this demonstration, we explored a use case for the Clex Importer tool, which populates the <code>lexicon</code> table in the STIX-D Corpus Database with entries from the ACE Common Lexicon (Clex). The project design leverages object-oriented programming principles to create a modular, extensible, and maintainable system, with key modules like <code>ClexImporter</code> and <code>MySQLRepository</code> facilitating database interactions and lexicon importation. The testing strategy includes unit, integration, and end-to-end tests to ensure the reliability and correctness of the codebase. By executing the Clex Importer tool via the command line interface and web interface, users can seamlessly import Clex entries into the database, supporting ACE-based natural language processing tasks.</p>
</div>
</div>
Expand Down
Binary file modified ling508/demos/demo_clex_importer_notes.pdf
View file
Binary file not shown.

0 comments on commit 5678718

Please sign in to comment.