srlearn / rnlp

Relational NLP: Convert text into relational facts.
https://rnlp.readthedocs.io/en/latest/
GNU General Public License v3.0
9 stars 5 forks source link

Documentation Overhaul #19

Closed hayesall closed 6 years ago

hayesall commented 6 years ago

This PR reorganizes the sphinx documentation, abbreviated as follows:

Since one of the example files is the U.S. Declaration of Independence, the learning task now reflects the task of determining if a sentence is part of the "List of Grievances" against King George III.


This PR modifies the example_files/doi.txt in order to change some of the end-of-line colon characters to periods. This change was made since the default nltk sentence-tokenizer does not consider colons to be end-of-sentence characters.

hayesall commented 6 years ago

@skinn009 I'd really appreciate a close review on this one, particularly in terms of the written content and whether the tutorial makes sense.

Pending acceptance, squashing these would probably be best.

codecov-io commented 6 years ago

Codecov Report

Merging #19 into development will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           development      #19   +/-   ##
============================================
  Coverage        95.48%   95.48%           
============================================
  Files                8        8           
  Lines              310      310           
============================================
  Hits               296      296           
  Misses              14       14

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update b0de66a...e5a6607. Read the comment docs.