Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ArgumentMandatoryDescription
Fixtures
[fixtures…]

A list of fixture files that should be run. If this is not specified, all the fixtures are tested. The following example runs the test on just two fixture files:

Code Block
squirro_kee test fixtures/acme.json fixtures/other_corp.json
General Options
--no-compile
Don't compile the lookup database. By default the compile sub-command is automatically executed when running the tests. That can be slow for large databases, in which case you may want to disable the compilation using this flag.
Snapshots
--snapshot
Creates a new snapshot from the current test results. Snapshots are stored on disk (in the snapshots folder by default) and are used to compare the KEE result quality over time.
--snapshot-message, -m

Add a comment to the snapshot. This implies --snapshot as well, so the following command is a short version of creating a snapshot and adding a comment:

Code Block
squirro_kee test -m "Tuned ngrams"
--diff
Compare the snapshot to the previous snapshot. This outputs how much better or worse the match quality has become.
Debugging
--stats
Outputs a summary for all the missed keywords. This provides a quick overview on what kind of entities are not yet detected as they should.
--trace STRING

Turns on detailed logging whenever the given candidate is being processed. For example if the lookup database contains an entry called "Acme Inc" then invoking kee as follows will result in a verbose log file every time that entry is looked at:

Code Block
squirro_kee test --trace "Acme Inc"

If this option is present, then the --verbose flag does not have any effect.

...