Update docs

yzhangcs · yzhangcs · commit 58fdaaad3c75 · 2021-12-25T17:32:42.000+08:00
diff --git a/docs/source/refs.bib b/docs/source/refs.bib
@@ -316,4 +316,36 @@ @inproceedings{kim-etal-2019-unsupervised
   publisher = {Association for Computational Linguistics},
   url       = {https://aclanthology.org/N19-1114},
   pages     = {1105--1117}
-}
+}
+
+@inproceedings{martins-etal-2016-sparsemax,
+  title     = {From Softmax to Sparsemax: A Sparse Model of Attention and Multi-Label Classification},
+  author    = {Martins, Andre and Astudillo, Ramon},
+  booktitle = {Proceedings of ICML},
+  year      = {2016},
+  address   = {New York, New York, USA},
+  publisher = {PMLR},
+  url       = {https://proceedings.mlr.press/v48/martins16.html},
+  pages     = {1614--1623}
+}
+
+
+@inproceedings{mensch-etal-2018-dp,
+  title     = {Differentiable Dynamic Programming for Structured Prediction and Attention},
+  author    = {Mensch, Arthur and Blondel, Mathieu},
+  booktitle = {Proceedings of ICML},
+  year      = {2018},
+  publisher = {PMLR},
+  url       = {https://proceedings.mlr.press/v80/mensch18a.html},
+  pages     = {3462--3471}
+}
+
+@inproceedings{correia-etal-2020-efficient,
+  author    = {Correia, Gon\c{c}alo and Niculae, Vlad and Aziz, Wilker and Martins, Andr\'{e}},
+  booktitle = {Advances in NIPS},
+  publisher = {Curran Associates, Inc.},
+  title     = {Efficient Marginalization of Discrete and Structured Latent Variables via Sparsity},
+  url       = {https://proceedings.neurips.cc/paper/2020/hash/887caadc3642e304ede659b734f79b00-Abstract.html},
+  year      = {2020},
+  pages     = {11789--11802}
+}
diff --git a/docs/source/structs/fn.rst b/docs/source/structs/fn.rst
@@ -1,20 +1,16 @@
-Algorithms
+Functions
 ==================================================================
 
-.. currentmodule:: supar.utils.alg
-
-KMeans
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autofunction:: supar.utils.alg.kmeans
+.. currentmodule:: supar.structs.fn
 
 Tarjan
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autofunction:: supar.utils.alg.tarjan
+.. autofunction:: supar.structs.fn.tarjan
 
 ChuLiuEdmods
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autofunction:: supar.utils.alg.chuliu_edmonds
+.. autofunction:: supar.structs.fn.chuliu_edmonds
 
 MST
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autofunction:: supar.utils.alg.mst
+.. autofunction:: supar.structs.fn.mst
diff --git a/docs/source/structs/index.rst b/docs/source/structs/index.rst
@@ -11,3 +11,4 @@ Structs
    tree
    linearchain
    vi
+   fn
diff --git a/docs/source/structs/semiring.rst b/docs/source/structs/semiring.rst
@@ -41,4 +41,9 @@ KLDivergenceSemiring
 SampledSemiring
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. autoclass:: SampledSemiring
+    :members:
+
+SparsemaxSemiring
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: SparsemaxSemiring
     :members:
diff --git a/docs/source/utils/fn.rst b/docs/source/utils/fn.rst
@@ -0,0 +1,12 @@
+Functions
+==================================================================
+
+.. currentmodule:: supar.utils.fn
+
+KMeans
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autofunction:: supar.utils.fn.kmeans
+
+Stripe
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autofunction:: supar.utils.fn.stripe
diff --git a/docs/source/utils/index.rst b/docs/source/utils/index.rst
@@ -6,8 +6,8 @@ Utils
 .. toctree::
    :maxdepth: 2
 
-   alg
    data
    field
    transform
    vocab
+   fn

-Original file line number
+Diff line change
    tree
    linearchain
    vi
 +   fn