3 fastest ways to try Bareun (cloud / Colab / Docker)
The fastest way to try Bareun (bareun) for the first time is one of three:
the cloud (api.bareun.ai), Google Colab, or Docker.
If installing feels like a burden, start right away with the cloud or Colab. If you want to run it on your own server, use Docker.
The cloud is free for up to 50,000 eojeol (space-delimited word units), so it is the lightest way to start.
Which method should I choose?
| Method | Installation | Best for | Notes |
|---|---|---|---|
| Cloud | None | Those who just want to see results quickly | 50,000 eojeol free, spell checker supported |
| Colab | None | Those who practice or do research in code | Only a browser is needed |
| Docker | A few commands | Those who will run it on their own server or in an air-gapped network | Provides the morphological analyzer |
All methods require an API key (koba-...) issued at bareun.ai.
Method 1: Use the cloud (api.bareun.ai) right away
This is the fastest way to start, with no installation. The cloud server is provided at api.bareun.ai, port 443, with TLS encryption. It supports three protocols: grpc, grpc-web, and REST.
How to use the cloud API is described in detail in Cloud API.
from bareunpy import Tagger
API_KEY = "koba-ABCDEFG-1234567-LMNOPQR-7654321" # Replace with your own key
tagger = Tagger(API_KEY, 'api.bareun.ai', 443)
res = tagger.tags(["바른을 클라우드로 써봅니다."])
print(res.pos())
Cloud free tier
The cloud free tier covers up to 50,000 eojeol. You use api.bareun.ai as is even in the free tier, and if you log in, you can check usage statistics in real time.
Both morphological analysis and the spell checker are available.
Method 2: Practice with Google Colab
All you need is a browser. In a Colab notebook, install the library and connect to the cloud server, and you can see results right away. For a step-by-step walkthrough, see Getting started with Colab.
!pip install bareunpy
from bareunpy import Tagger
API_KEY = "koba-ABCDEFG-1234567-LMNOPQR-7654321" # Replace with your own key
tagger = Tagger(API_KEY, 'api.bareun.ai', 443)
print(tagger.tags(["바른을 코랩에서 실습해봅니다."]).pos())
For research and practice, the free tier alone is enough to analyze a wide variety of sentences.
Method 3: Run it on your own server with Docker
If you want to run it in your own environment, Docker is the fastest.
docker pull bareunai/bareun:latest
mkdir -p ~/bareun/var
docker run -d -p 5656:5656 -v ~/bareun/var:/bareun/var bareunai/bareun:latest
docker exec bareun /bareun/bin/bareun -reg koba-ABCDEFG-1234567-LMNOPQR-7654321
The Docker distribution serves on port 5656. For more detailed steps, see
Docker 10-minute installation guide and Quick start.
Do not use the example key as is
The koba-... above is an example. Replace it with your own API key.
Frequently asked questions
Q. What is the fastest method?
The cloud (api.bareun.ai), which needs no installation at all. With just an API key, calls work right away.
Q. How are Colab and the cloud different?
Colab is a notebook environment for running code, and the analysis itself is handled by the cloud server (api.bareun.ai). The two are used together.
Q. How much can I try for free?
Within the cloud free tier of 50,000 eojeol, you can try both morphological analysis and the spell checker.
Q. Which programming languages are supported?
Python (pip install bareunpy), Java, JavaScript, and R are supported out of the box, and an Elasticsearch plugin is also provided. The REST API and gRPC are supported too.