Skip to content

Commit f1745f2

Browse files
arjungtensorflow-copybara
authored andcommitted
Move framework.md out of the tutorials directory.
The framework description is a standalone document and doesn't belong with the tutorials, which are examples demonstrating the use of the NSL framework. PiperOrigin-RevId: 268250707
1 parent fcc311f commit f1745f2

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

g3doc/_book.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ upper_tabs:
1414
- name: Guide & Tutorials
1515
contents:
1616
- title: Framework
17-
path: /neural_structured_learning/tutorials/framework
17+
path: /neural_structured_learning/framework
1818
- title: Install
1919
path: /neural_structured_learning/install
2020
- heading: Neural graph learning tutorials

g3doc/_index.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ landing_page:
3232
</ul>
3333
<p>Incorporating structured signals is done only during training. So, the performance of the
3434
serving/inference workflow remains unchanged. More information on neural structured learning
35-
can be found in our <a href="tutorials/framework">framework description</a>. To get started,
35+
can be found in our <a href="framework">framework description</a>. To get started,
3636
please see our <a href="install"> install guide</a>, and for a practical introduction to
37-
NSL, check out our <a href="tutorials/framework#step-by-step_tutorials">tutorials.</a></p>
37+
NSL, check out our <a href="framework#step-by-step_tutorials">tutorials.</a></p>
3838
- code_block: |
3939
<pre class = "prettyprint">
4040
import tensorflow as tf

g3doc/tutorials/framework.md renamed to g3doc/framework.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ minimizing the neighbor loss, see the figure below). This technique is generic
1111
and can be applied on arbitrary neural architectures (such as Feed-forward NNs,
1212
Convolutional NNs and Recurrent NNs).
1313

14-
![NSL Concept](../images/nlink_figure.png)
14+
![NSL Concept](images/nlink_figure.png)
1515

1616
Note that the generalized neighbor loss equation is flexible and can have other
1717
forms besides the one illustrated above. For example, we can also select
@@ -41,7 +41,7 @@ neighbor loss. On the other hand, for induced neighbor-based regularization
4141
(adversarial), we compute the neighbor loss as the distance between the output
4242
prediction of the induced adversarial neighbor and the ground truth label.
4343

44-
![NSL workflow](../images/workflow_overview.png)
44+
![NSL workflow](images/workflow_overview.png)
4545

4646
## Why use NSL?
4747

@@ -80,15 +80,15 @@ To obtain hands-on experience with Neural Structured Learning, we have three
8080
tutorials that cover various scenarios where structured signals may be
8181
explicitly given, induced or constructed:
8282

83-
* [Graph regularization for document classification using natural graphs](graph_keras_mlp_cora.ipynb).
83+
* [Graph regularization for document classification using natural graphs](tutorials/graph_keras_mlp_cora.ipynb).
8484
In this tutorial, we explore the use of graph regularization to classify
8585
documents that form a natural (organic) graph.
8686

87-
* [Graph regularization for sentiment classification using synthesized graphs](graph_keras_lstm_imdb.ipynb).
87+
* [Graph regularization for sentiment classification using synthesized graphs](tutorials/graph_keras_lstm_imdb.ipynb).
8888
In this tutorial, we demonstrate the use of graph regularization to classify
8989
movie review sentiments by constructing (synthesizing) structured signals.
9090

91-
* [Adversarial learning for image classification](adversarial_keras_cnn_mnist.ipynb).
91+
* [Adversarial learning for image classification](tutorials/adversarial_keras_cnn_mnist.ipynb).
9292
In this tutorial, we explore the use of adversarial learning (where
9393
structured signals are induced) to classify images containing numeric
9494
digits.

0 commit comments

Comments
 (0)