Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document RNN #4

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/ci-cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ jobs:
with:
python-version: "3.10"
- name: Package up SDK
if: github.ref == 'refs/heads/master'
run: python setup.py sdist
- name: Publish a Python distribution to PyPI
if: github.ref == 'refs/heads/master'
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.idea/
.DS_Store
__pycache__
Binary file removed docs/source/img/architecture-rnn-ltr.png
Binary file not shown.
Binary file removed docs/source/img/architecture-rnn-ltr.psd
Binary file not shown.
Binary file added docs/source/img/char-level-language-model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/img/description-block-rnn-ltr.png
Binary file not shown.
Binary file removed docs/source/img/description-block-rnn-ltr.psd
Binary file not shown.
Binary file removed docs/source/img/gradient-clipping.png
Binary file not shown.
121 changes: 121 additions & 0 deletions docs/source/img/rnn-4-black-boxes-connected.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<mxfile host="app.diagrams.net" modified="2024-03-19T01:01:04.926Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36" etag="OgWHmKqu6mVN4yDKoCwM" version="24.0.7" type="device">
<diagram name="Page-1" id="gxr7cFC-hZQY0lpAcxoR">
<mxGraphModel dx="816" dy="516" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="o5WZRm4PuDRFcwwRBSCM-21" value="&lt;font size=&quot;1&quot; data-font-src=&quot;https://fonts.googleapis.com/css?family=Italianno&quot; face=&quot;Italianno&quot; style=&quot;&quot; color=&quot;#ffffff&quot;&gt;&lt;b style=&quot;font-size: 27px;&quot;&gt;f&lt;/b&gt;&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#000000;strokeColor=none;fontColor=#FF6666;" vertex="1" parent="1">
<mxGeometry x="40" y="320" width="60" height="60" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-22" value="&lt;font color=&quot;#ffffff&quot; face=&quot;Italianno&quot; style=&quot;font-size: 27px;&quot;&gt;f&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#000000;strokeColor=none;fontColor=#FF6666;" vertex="1" parent="1">
<mxGeometry x="180" y="320" width="60" height="60" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-23" value="&lt;span style=&quot;color: rgb(255, 255, 255); font-family: Italianno; font-size: 27px;&quot;&gt;f&lt;/span&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#000000;strokeColor=none;fontColor=#FF6666;" vertex="1" parent="1">
<mxGeometry x="320" y="320" width="60" height="60" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-24" value="&lt;span style=&quot;color: rgb(255, 255, 255); font-family: Italianno; font-size: 27px;&quot;&gt;f&lt;/span&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#000000;strokeColor=none;fontColor=#FF6666;" vertex="1" parent="1">
<mxGeometry x="460" y="320" width="60" height="60" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-25" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="69.5" y="439" as="sourcePoint" />
<mxPoint x="69.5" y="389" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-26" value="&lt;font face=&quot;Ubuntu&quot; style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;h&lt;/b&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#00CC00;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="45" y="450" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-27" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="69.5" y="310" as="sourcePoint" />
<mxPoint x="69.5" y="260" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-28" value="&lt;font face=&quot;Ubuntu&quot;&gt;&lt;span style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;e&lt;/b&gt;&lt;/span&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#FF3399;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="45" y="200" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-29" value="&lt;font face=&quot;Ubuntu&quot;&gt;&lt;span style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;l&lt;/b&gt;&lt;/span&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#FF3399;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="185" y="200" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-30" value="&lt;font face=&quot;Ubuntu&quot;&gt;&lt;span style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;l&lt;/b&gt;&lt;/span&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#FF3399;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="325" y="200" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-31" value="&lt;font face=&quot;Ubuntu&quot;&gt;&lt;span style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;o&lt;/b&gt;&lt;/span&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#FF3399;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="465" y="200" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-32" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="209.5" y="310" as="sourcePoint" />
<mxPoint x="209.5" y="260" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-33" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="349.5" y="310" as="sourcePoint" />
<mxPoint x="349.5" y="260" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-34" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="489.5" y="310" as="sourcePoint" />
<mxPoint x="489.5" y="260" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-35" value="&lt;font face=&quot;Ubuntu&quot; style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;e&lt;/b&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#00CC00;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="185" y="450" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-36" value="&lt;font face=&quot;Ubuntu&quot; style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;l&lt;/b&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#00CC00;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="325" y="450" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-37" value="&lt;font face=&quot;Ubuntu&quot; style=&quot;font-size: 20px;&quot;&gt;&lt;b&gt;l&lt;/b&gt;&lt;/font&gt;" style="ellipse;whiteSpace=wrap;html=1;aspect=fixed;fillColor=#00CC00;fontColor=#FFFFFF;" vertex="1" parent="1">
<mxGeometry x="465" y="450" width="50" height="50" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-38" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="209.5" y="440" as="sourcePoint" />
<mxPoint x="209.5" y="390" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-39" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="349.5" y="440" as="sourcePoint" />
<mxPoint x="349.5" y="390" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-40" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#6666FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="489.5" y="440" as="sourcePoint" />
<mxPoint x="489.5" y="390" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-44" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#B266FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="110" y="349.78" as="sourcePoint" />
<mxPoint x="170.5" y="349.78" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-45" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#B266FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="250" y="349.76" as="sourcePoint" />
<mxPoint x="310.5" y="349.76" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-46" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;strokeWidth=3;strokeColor=#B266FF;fontColor=#FF6666;" edge="1" parent="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="394.75" y="349.76" as="sourcePoint" />
<mxPoint x="455.25" y="349.76" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-47" value="&lt;font data-font-src=&quot;https://fonts.googleapis.com/css?family=Italianno&quot; face=&quot;Italianno&quot; style=&quot;font-size: 25px;&quot;&gt;&lt;span style=&quot;font-size: 25px;&quot;&gt;h&lt;sub style=&quot;font-size: 25px;&quot;&gt;1&lt;/sub&gt;&lt;/span&gt;&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=25;fontStyle=1" vertex="1" parent="1">
<mxGeometry x="110" y="320" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-48" value="&lt;font style=&quot;font-size: 25px;&quot;&gt;&lt;span style=&quot;font-size: 25px;&quot;&gt;&lt;span style=&quot;font-size: 25px;&quot;&gt;h&lt;/span&gt;&lt;span style=&quot;font-size: 25px;&quot;&gt;&lt;sub style=&quot;font-size: 25px;&quot;&gt;2&lt;/sub&gt;&lt;/span&gt;&lt;/span&gt;&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Italianno;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DItalianno;fontSize=25;fontStyle=1" vertex="1" parent="1">
<mxGeometry x="250" y="320" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="o5WZRm4PuDRFcwwRBSCM-49" value="&lt;font style=&quot;font-size: 25px;&quot;&gt;&lt;span style=&quot;font-size: 25px;&quot;&gt;&lt;span style=&quot;font-size: 25px;&quot;&gt;h&lt;/span&gt;&lt;span style=&quot;font-size: 25px;&quot;&gt;&lt;sub style=&quot;font-size: 25px;&quot;&gt;3&lt;/sub&gt;&lt;/span&gt;&lt;/span&gt;&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Italianno;fontSource=https%3A%2F%2Ffonts.googleapis.com%2Fcss%3Ffamily%3DItalianno;fontSize=25;fontStyle=1" vertex="1" parent="1">
<mxGeometry x="390" y="320" width="60" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file added docs/source/img/rnn-4-black-boxes-connected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading