bareunai/bareun repository overview

⁠bareun

• Bareun is a deep learning based Korean pos tagging engine.
• Trained with 2020 NIKL(국립국어원, National Institute of Korean Language) corpus v1.0⁠.
• Trained with news corpus from BIGKINDS, which is provided by Korean Press Foundation⁠.

⁠How to run

# create a local folder for custom dictionaries.
$ mkdir -p bareun/var/custom-dict

# run bareun docker
$ docker run \
    -d \
    --restart unless-stopped \
    --name bareun \
    --user $UID:$GID \
    -p 5656:5656 \
    -p 9902:9902 \
    -v bareun/var:/bareun/var \
   bareunai/bareun:latest

⁠How to activate

You sholud visit http://localhost:5656/⁠ to activate bareun service.

Please follow the steps below.

• Visit https://bareun.ai⁠ to sign up.
• Get API KEY for your own.
• Register API KEY for your own.

⁠How to use

To use Barun, you must use a programming language.

Choose your preferred development language. You can choose Python, Java, JavaScript, R, etc.

• pyhon: pip install bareunpy
• Java: Install the maven package bareun
• R: Install RBareun
• JavaScript: npm install bareun

If the language you want to use is not among these, for example go language, php, ruby, php, .net, you can use bareun by following the manual. Please refer to the manual entry http://localhost:5757/manual/extend⁠.

⁠port 5656

Through this 5656 port, three services are performed simultaneously.

• grpc
• REST APIs: http://localhost:5656/bareun/api/v1/analyze⁠
• grpc-web: http://localhost:5656/bareun.LanguageService/AnalyzeSyntax⁠

Besides, you can try out the features and view the documentation for bareun.

• http://localhost:5656/⁠
• http://localhost:5656/manual/⁠

⁠How to minitor

Because Barun runs as a server, various monitoring methods are available. You can view logs or view service status.

⁠See docker logs

# docker logs -f [container-id or container-name]
$ docker logs -f bareun

⁠Service monitor

You can view the service status via http://localhost:9902/⁠. The bareun docker image includes envoy by default.

⁠Commercial support

If you want to use it in a closed network without internet or use it all the time, you must obtain a dedicated license. To obtain a license, refer https://bareun.ai/⁠.

After receiving the license file, copy the license.pem file to bareun/var.

$ cp license-your-own.pem bareun/var/license.pem