From b611cbd0629eb2aed9f840b50d1b3f8869c2589e Mon Sep 17 00:00:00 2001 From: Gunther Cox Date: Thu, 24 Aug 2017 06:12:48 -0400 Subject: [PATCH] Information about the corpus data format has been moved to the chatterbot-corpus documentation --- docs/corpus.rst | 71 +++++-------------------------------------------- 1 file changed, 6 insertions(+), 65 deletions(-) diff --git a/docs/corpus.rst b/docs/corpus.rst index 3523a1630..c0c415364 100644 --- a/docs/corpus.rst +++ b/docs/corpus.rst @@ -3,6 +3,9 @@ ChatterBot Corpus This is a :term:`corpus` of dialog data that is included in the chatterbot module. +Additional information about the ``chatterbot-corpus`` module can be found +in the `ChatterBot Corpus Documentation`_. + Corpus language availability ---------------------------- @@ -18,70 +21,8 @@ check out the `chatterbot_corpus/data`_ directory in the separate chatterbot-cor https://github.com/gunthercox/chatterbot-corpus - The :code:`chatterbot-corpus` is distributed in its own Python package so that it can - be released and upgraded independently from the :code:`chatterbot` package. - - -Data Format ------------ - -The data file contained in ChatterBot Corpus is formatted using `YAML`_ syntax. -This format is used because it is easily readable by both humans and machines. - -.. list-table:: Corpus Properties - :widths: 15 10 30 - :header-rows: 1 - - * - Property - - Required - - Description - * - categories - - Required - - A list of categories that describe the conversations. - * - conversations - - Optional - - A list of conversations. Each conversation is denoted as a list. - -Here is an example of the corpus data: - -.. code-block:: yaml - :name: corpus-example.yml - - categories: - - english - - greetings - conversations: - - - Hello - - Hi - - - Hello - - Hi, how are you? - - I am doing well. - - - Good day to you sir! - - Why thank you. - - - Hi, How is it going? - - It's going good, your self? - - Mighty fine, thank you. - -The values in this example have the following relationships. - -.. list-table:: Evaluated statement relationships - :widths: 15 40 - :header-rows: 1 - - * - Statement - - Response - * - Hello - - Hi - * - Hello - - Hi, how are you? - * - Hi, how are you? - - I am doing well. - * - Good day to you sir! - - Why thank you. - * - Hi, How is it going? - - It's going good, your self? - * - It's going good, your self? - - Mighty fine, thank you. + The ``chatterbot-corpus`` is distributed in its own Python package so that it can + be released and upgraded independently from the ``chatterbot`` package. Exporting your chat bot's database as a training corpus @@ -104,4 +45,4 @@ Here is an example: :language: python .. _chatterbot_corpus/data: https://github.com/gunthercox/chatterbot-corpus/tree/master/chatterbot_corpus/data -.. _YAML: http://www.yaml.org/ +.. _ChatterBot Corpus Documentation: http://chatterbot-corpus.readthedocs.io/