Skip to main content

Tiny DSL to generate training dataset for NLU engines

Project description

Tiny DSL to generate training dataset for NLU engines. Based on the javascript implementation of chatl.

Installation

pip

$ pip install pychatl

source

$ git clone https://github.com/atlassistant/pychatl.git
$ cd pychatl
$ python setup.py install

or

$ pip install -e .

Usage

From the terminal

$ pychatl .\example\forecast.dsl .\example\lights.dsl -a snips -o '{ \"language\": \"en\" }'

From the code

from pychatl import parse

result = parse("""
# pychatl is really easy to understand.
#
# You can defines:
#   - Intents
#   - Entities (with or without variants)
#   - Synonyms
#   - Comments (only at the top level)

# Inside an intent, you got training data.
# Training data can refer to one or more entities and/or synonyms, they will be used
# by generators to generate all possible permutations and training samples.

%[my_intent]
  ~[greet] some training data @[date]
  another training data that uses an @[entity] at @[date#with_variant]

~[greet]
  hi
  hello

# Entities contains available samples and could refer to a synonym.

@[entity]
  some value
  other value
  ~[a synonym]

# Synonyms contains only raw values

~[a synonym]
  possible synonym
  another one

# Entities and intents can define arbitrary properties that will be made available
# to generators.
# For snips, `snips:type` and `extensible` are used for example.

@[date](snips:type=snips/datetime)
  tomorrow
  today

# Variants is used only to generate training sample with specific values that should
# maps to the same entity name, here `date`. Props will be merged with the root entity.

@[date#with_variant]
  the end of the day
  nine o clock
  twenty past five
""")

# Now you got a parsed dataset so you may want to process it for a specific NLU engines

from pychatl.postprocess import snips

snips_dataset = snips(result) # Or give options with `snips(result, language='en')`

# And now you got your dataset ready to be fitted within snips-nlu!

Adapters

For now, only the snips adapter has been done. Here is a list of adapters and their respective properties:

adapter

type Specific type of the entity to use

extensible Are values outside of training allowed?

snips

✔️ with snips:type

✔️

Testing

$ cd tests/
$ python -m unittest -v

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pychatl-1.2.0.tar.gz (6.1 kB view details)

Uploaded Source

File details

Details for the file pychatl-1.2.0.tar.gz.

File metadata

  • Download URL: pychatl-1.2.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.2.0 requests-toolbelt/0.8.0 tqdm/4.19.6 CPython/3.6.2

File hashes

Hashes for pychatl-1.2.0.tar.gz
Algorithm Hash digest
SHA256 390d557046f540cb29d8f7b7f767be6926bfc217b283501e0b2d0057be9ecf25
MD5 8efe1a9915c6594d8349840a55ca9d5e
BLAKE2b-256 65786e9bc60b12be96bcf2f5ee984218c5e72a30369dfdaffa4bc0519d0362b2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page