Skip to content

Commit d3083be

Browse files
authored
Doc indexing (#633)
* initail commit * stash * rename outline file and add indexing sections * add sections * add outline sections * fixed wikipedia dataset hyperlink * data.rst * Revert "data.rst" This reverts commit d0d08c5. * index.rst * edit based on code review * fix section level * remove TOC and add outline ind index.rst * stash * remove hyperlinks to files outside docs * add a word spelling
1 parent b13c582 commit d3083be

8 files changed

+53
-7
lines changed

docs/index.rst

+12-6
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,23 @@ Welcome to Forte's documentation!
22
******************************************
33

44
.. toctree::
5-
:maxdepth: 1
5+
:maxdepth: 2
6+
7+
outline.md
8+
9+
10+
.. toctree::
11+
:maxdepth: 2
612

7-
get_started.md
13+
tutorial/get_started.md
814

915
.. toctree::
1016
:maxdepth: 2
1117

12-
examples.md
13-
ontology_generation.md
14-
audio_processing.md
15-
data_pack.md
18+
tutorial/examples.md
19+
tutorial/ontology_generation.md
20+
tutorial/audio_processing.md
21+
tutorial/data_pack.md
1622

1723
API
1824
====

docs/outline.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
This outline is currently **in progress** so many sections are empty.
2+
3+
# Outline
4+
## 0. Overview
5+
* [get started](tutorial/get_started.md)
6+
## 1. Handling Structured Text Data
7+
* [data_pack](tutorial/data_pack.md)
8+
## 2. Processing Raw Text
9+
### Reader
10+
### Ontology
11+
### Dataset
12+
* wikipedia dataset
13+
### Serialization
14+
## 3. Building a NLP Pipeline
15+
### Text Classification
16+
* use text classification as a example to introduce pipeline components
17+
## 4. Linguistic Analysis
18+
* Analyze linguistic structure within a sentence.
19+
* more concrete examples of `context` and `get_data()` on top of [Handling Structured Text Data](#1-handling-structured-text-data)
20+
### Part-of-Speech Tagging
21+
## 5. Language Modeling with External Library
22+
* predictor
23+
## 6. Application
24+
### Information Extraction
25+
#### Named Entity Recognition
26+
#### Relation Extraction
27+
### Information Retrieval
28+
#### Indexing
29+
#### Ranking
30+
### Machine Translation
31+
### Text Generation
32+
### Question Answering System
33+
### Chatbot
34+
## 7. Tasks on Other Modalities
35+
### Audio
36+
#### Automatic Speech Recognition
37+
#### Speaker Segmentation
38+
### Image Data
39+
#### Image Classification

docs/spelling_wordlist.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,5 @@ docstrings
139139
numpy
140140
jsonpickle
141141
crowdworkers
142-
subword
142+
subword
143+
wikipedia
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)