Skip to content

Commit d1e65f4

Browse files
Merge pull request #4 from hellohaptik/doc_changes
document changes
2 parents b4e2c91 + a55fb3f commit d1e65f4

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/source/examples.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
Examples
22
===========
3-
Here you can find various conversational AI tasks as examples and can train multi-task models
4-
in simple steps mentioned in the notebooks.
3+
Here you can find various NLP (especially conversational AI) tasks as examples and can train them either in multi-task or single-task manner, using some simple steps mentioned in the notebooks.
54

65
Example-1 Intent detection, NER, Fragment detection
76
---------------------------------------------------
87

98
**Tasks Description**
109

11-
``Intent Detection`` :- This is a single sentence classification task where an `intent` specifies which class the data sample belongs to.
10+
``Intent Detection`` :- This can be modeled as a single sentence classification task where an `intent` specifies which class the query belongs to.
1211

1312
``NER`` :- This is a Named Entity Recognition/ Sequence Labelling/ Slot filling task where individual words of the sentence are tagged with an entity label it belongs to. The words which don't belong to any entity label are simply labeled as "O".
1413

@@ -18,7 +17,7 @@ Example-1 Intent detection, NER, Fragment detection
1817

1918
NER helps in extracting values for required entities (eg. location, date-time) from query.
2019

21-
Fragment detection is a very useful piece in conversational system as knowing if a query/sentence is incomplete can aid in discarding bad queries beforehand.
20+
Fragment detection is a very useful piece in conversational system as knowing if a query/sentence is incomplete can aid in recognising ill-formed , incomplete user queries and apprpriate expanded options can be provided to the user .
2221

2322
**Data** :- In this example, we are using the `SNIPS <https://snips-nlu.readthedocs.io/en/latest/dataset.html>`_ data for intent and entity detection. For the sake of simplicity, we provide
2423
the data in simpler form under ``snips_data`` directory taken from `here <https://github.com/LeePleased/StackPropagation-SLU/tree/master/data/snips>`_.
@@ -29,15 +28,14 @@ the data in simpler form under ``snips_data`` directory taken from `here <https:
2928

3029
**Notebook** :- `intent_ner_fragment <https://github.com/hellohaptik/multi-task-NLP/blob/master/examples/intent_ner_fragment/intent_ner_fragment.ipynb>`_
3130

32-
Example-2 Entailment detection
31+
Example-2 Recognising Textual Entailment
3332
------------------------------
3433

3534
**Tasks Description**
3635

37-
``Entailment`` :- This is a sentence pair classification task which determines whether the second sentence in a sample can be inferred from the first.
36+
``Entailment`` :- This is a sentence pair classification task . Given two text instances ‘premise’ and ‘Hypothesis’, Textual Entailment Recognition is the task of determining whether the hypothesis is entailed (can be inferred) from the premise or not.
3837

39-
**Conversational Utility** :- In conversational AI context, this task can be seen as determining whether the second sentence is similar to first or not.
40-
Additionally, the probability score can also be used as a similarity score between the sentences.
38+
**Conversational Utility** :- it can be used for evaluating pairwise similarity between queries , also to determine if a query is out-of-context or adversarial in conversational AI usecases like FAQ question answering.
4139

4240
**Data** :- In this example, we are using the `SNLI <https://nlp.stanford.edu/projects/snli>`_ data which is having sentence pairs and labels.
4341

0 commit comments

Comments
 (0)