.. image:: https://travis-ci.org/wwunlp/sner.png :alt: Build Status :target: https://travis-ci.org/wwunlp/sner
.. image:: https://readthedocs.org/projects/sner/badge/?version=latest :alt: Documentation Status :target: https://sner.readthedocs.io
.. code-block:: bash
$ pip3 install sumerian-ner
If you are not in a
virtualenv <https://virtualenv.pypa.io>
_
you may need to use pip3
with sudo
or --user
.
If you'd rather clone the repository.
.. code-block:: bash
$ git clone https://github.com/wwunlp/sner.git $ cd sner/ $ pip3 install .
If you used pip3
to install sner
,
you can call sner
from the command line.
If you cloned the repo, you can run python3 -m sner
from within the repo.
-r
or --run
: Run one of the following models:
dec
, nbc
, ner
, rdf
, sgd
, or svc
.
Or one of the following routines: analysis
, export
,
export-atf
, formatting
, over-fit
, or testing
.
-cf
or --config
: Configuration file to use.
-p
or --path
: Path to data directory.
-c
or --corpus
: File name of the corpus.
-a
or --attestations
: File name of the attestations.
-sr
or --seed-rules
: File name of the seed rules.
-i
or --iterations
: Number of iterations.
-mr
or --max-rules
: Max number of rules per iterations.
-al
or --alpha
: Alpha value.
-k
or --k
: K value.
-nd
or --norm-date
: Enable date normalization.
-ng
or --norm-geo
: Enable geographical name normalization.
-nn
or --norm-num
: Enable number normalization.
-np
or --norm-prof
: Enable profession normalization.
sner
will check sner.conf
before using default value.
The sner.conf
uses JSON
syntax.
i.e. --corpus corpus.csv
would be "corpus": "corpus.csv"
.
If you want to change the hyperparameters used,
you can define them in sner.conf
.
If your sner.conf
is not in the root of the repository,
you can set the environment variable SNER_CONF
to the path of sner.conf
.
.. image:: https://i.imgur.com/CpI851D.jpg :align: center :alt: Corgi playing in snow, with text 'ERMAHGERD SNER'