@microsoft/bf-sampling-cli
======================

This package is a plugin for @microsoft/botframework-cli. It is not designed to be consumed as an independent package.


Sampler CLI is used for sampling utterances of lu files.

Prerequisite

- Node.js version 12 or higher
- @microsoft/botframework-cli
``
$ npm install -g @microsoft/botframework-cli
`

Installation

To install the bf-sampler-cli plugin:

`
bf plugins:install @microsoft/bf-sampler-cli@beta
`

To uninstall the bf-sampler-cli plugin, a step for upgrading the plugin:

`
bf plugins:uninstall @microsoft/bf-sampler-cli
`

Commands

* bf sampler
* bf sampler:sampling



bf sampler



Display Sampler CLI available commands

`
USAGE
$ bf sampler -h

OPTIONS
-h, --help Sampler commands help
`

_See code: [src\commands\orchestrator\index.ts]https://github.com/microsoft/botframework-cli/blob/beta/packages/sampler/src/commands/sampler/index.ts)_



bf sampler:sampling



Do sampling to utterances in lu files.

`
USAGE
$ bf sampler:sampling -h

OPTIONS
-f, --force [Default: false] Force overwrites files if they already exist.
-h, --help Orchestrator 'assess' command help.
-i, --in=in Path to lu file or folder that contains lu files. Default to current working directory.
-o, --out=out Path where sampled lu files will be placed. Default to current working directory.
--maxImbalanceRatio=maxImbalanceRatio [Default: 10] Max imbalance ratio for sampling.
--maxUtteranceAllowed=maxUtteranceAllowed [Default: 15000] Max utterances allowed after samping.
--sampleSize=sampleSize [Default: 2] sample size.

EXAMPLE
bf sampler:sampling --in ./path/to/file/or/folder --out ./path/to/folder/ --maxImbalanceRatio 10 --maxUtteranceAllowed 15000 --sampleSize 2
``

_See code: [src\commands\orchestrator\assess.ts]https://github.com/microsoft/botframework-cli/blob/beta/packages/orchestrator/src/commands/sampler/sampling.ts)_