Commits

yanchuan sim committed 30cd7d0

added documentation structure and templates

  • Participants
  • Parent commits 0620d74

Comments (0)

Files changed (7)

+*******************
+*bleu* module
+*******************
+
+This module contains methods for computing the BLEU precision/recall from two given list of tokens. It also contains a useful method for counting ngram occurrences.
+
+See `BLEU: a Method for Automatic Evaluation of Machine Translation (Papineni et al, 2002) <http://dl.acm.org/citation.cfm?id=1073135>`_ for more information about the BLEU metric.
+
+Module methods
+==============
+.. automodule:: ycutils.bleu
+  :members: score, count_ngrams
+
+*******************
+*urls* module
+*******************
+
+This module contains classes and methods that are useful when trying to download data from HTTP addresses.
+
+The following sub-modules are available.
+
+.. toctree::
+  :maxdepth: 1
+
+  urls/webpages
+  urls/printable
+  urls/googlebooks
+  urls/wikipedia
+  urls/youtube
+
+Module methods
+==============
+
+This module contains basic methods that deal with URL addresses.
+
+.. automodule:: ycutils.urls
+  :members: sort_key, follow_url
+

sphinx/urls/googlebooks.rst

+*******************
+*googlebooks* module
+*******************
+
+This module contain methods for downloading descriptions of `Google books <http://books.google.com>`_.
+
+Module methods
+==============
+
+.. automodule:: ycutils.urls.googlebooks
+  :members: download, book_id
+

sphinx/urls/printable.rst

+*******************
+*printable* module
+*******************
+
+This module contain methods for downloading printable versions of webpages.
+
+.. note:: The scripts and data necessary for training the logistic regression classifier is contained in ``./printable_url`` folder of the source tree. The default model is trained on all 2361 instances of our data, achieving 98% cross validation accuracy. Feel free to modify the code as you wish to add features that you think might improve the classification accuracy.
+
+*PrintableURL* class
+====================
+.. autoclass:: ycutils.urls.printable.PrintableURL
+   :members:
+

sphinx/urls/webpages.rst

+*******************
+*webpages* module
+*******************
+
+This module contain methods for downloading webpages.
+
+Module methods
+==============
+
+This module contains basic methods that deal with URL addresses.
+
+.. automodule:: ycutils.urls.webpages
+  :members: download, WGET_PATH, USER_AGENT, MAX_TRIES
+

sphinx/urls/wikipedia.rst

+*******************
+*wikipedia* module
+*******************
+
+This module contain methods for downloading `Wikipedia <http://www.wikipedia.org>`_ articles.
+
+Module methods
+==============
+.. automodule:: ycutils.urls.wikipedia
+  :members: download, domain_and_title
+

sphinx/urls/youtube.rst

+*******************
+*youtube* module
+*******************
+
+This module contain methods for downloading `Youtube <http://www.youtube.com>`_ video descriptions.
+
+Module methods
+==============
+.. automodule:: ycutils.urls.youtube
+  :members: download, get_video_id
+