Commit e2c6759b authored by Jaden's avatar Jaden
Browse files

clean up some of the doc

parent 8930f4ac
......@@ -27,11 +27,11 @@ BEAT Command-line Client
.. _beat-cmdline-introduction:
This package implements a Python-based client for BEAT's web service or locally
This package provides a Python-based client for BEAT's web service or locally
installed repositories. It allows users to list, validate, edit, download and
upload objects from remote BEAT instances. It dubs as a Python-client API for
packages required to implement more advanced functionality than already
available on the currently avaiable tool, called `beat`, as we shall see next.
upload objects from remote BEAT instances, as well as running BEAT experiments
locally. It also doubles as a Python-client API for packages that need to
implement more advanced functionality than this client (`beat`) provides.
.. toctree::
......
......@@ -44,19 +44,19 @@ typical directory structure in a prefix directory:
:cwd: ..
Each of the subdirectories in the prefix keeps only objects of a given type.
For example, the ``dataformats`` subdirectory keeps only data format objects
For example, the ``dataformats`` subdirectory keeps only data format objects,
and so on. Inside each subdirectory, the user will find an organization that
resembles the naming convention of objects in the BEAT platform. For example,
you'd be able to find the data format ``my_dataformat``, belonging to user
``user``, version ``1``, under the directory
``<prefix>/dataformats/user/my_dataformat/1``. Objects are described by a JSON
file, an option full-length description in reStructuredText format and,
file, an optional full-length description in reStructuredText format and,
depending on the object type, a program file containing user routines
programmed in one of the supported languages.
The ``beat`` command-line utility bridges user interaction with a remote BEAT
web platform and locally available objects in a seamless way. The program is
normally available on your work environment:
normally available in the Idiap work environment:
.. command-output:: ./bin/beat --help
:cwd: ..
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment