Skip to content

Commit

Permalink
docs: Some minor fixes (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
YuukanOO committed Jul 25, 2019
1 parent 89ce991 commit feaf60c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
4 changes: 4 additions & 0 deletions docs/getting_started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,7 @@ to download only needed english resources or:
$ snips-nlu download-all-languages
to download all language resources.

.. note::

On windows, it will complain about not being able to link packages. You can safely ignore this message.
4 changes: 3 additions & 1 deletion docs/getting_started/usage.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
Usage
=====

.. _using_repl:

Using the pytlas CLI
--------------------

pytlas include a basic CLI interface to interact with the system.
pytlas include a basic CLI interface to interact with the system and help you build skill efficiently.

This line will start the pytlas REPL with skills located in the example/skills/ directory (in the git repository). It will load all data and fit the engine before starting the interactive prompt. The `-c cache/` lets the interpreter save its trained data to this folder to speed up the loading at the next launch if training data has not changed since.

Expand Down
2 changes: 1 addition & 1 deletion docs/writing_skills/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Writing skills
==============

Writing a skill for **pytlas** is as easy as creating a python module, writing some code that use `pytlas` members and putting it in the skills directory of your instance.
Writing a skill for **pytlas** is as easy as creating a python module, writing some code that use `pytlas` members and putting it in the skills directory of your instance (when :ref:`using_repl`).

There's only two parts that your skill should always define to make it work, :ref:`training` and :ref:`handler`.

Expand Down

0 comments on commit feaf60c

Please sign in to comment.