politely 2.7.0.dev0

An explainable politeness styler for the Korean Language

Politely

Politely is an explainable politeness styler for the Korean language (work in progress)

Quick Start 🚀

1️⃣ Install politely

pip3 install politely

2️⃣ Speak politely with Styler

from politely import Styler
styler = Styler()
print(styler("난 내 목표를 향해 달려.", 2))  # casual -> polite
print(styler("난 내 목표를 향해 달려.", 3))  # casual -> formal
print(styler("전 제 목표를 향해 달려요.", 1))  # polite -> casual
print(styler("전 제 목표를 향해 달려요.", 3))  # polite -> formal

전 제 목표를 향해 달려요.
전 제 목표를 향해 달립니다.
난 내 목표를 향해 달려.
전 제 목표를 향해 달립니다.

print(styler("오늘이 어제보다 더워.", 2))  # casual -> polite
print(styler("오늘이 어제보다 더워.", 3))  # casual -> formal
print(styler("오늘이 어제보다 더워요.", 1))  # polite -> casual 
print(styler("오늘이 어제보다 더워요.", 3))  # polite -> formal

오늘이 어제보다 더워요.
오늘이 어제보다 덥습니다.
오늘이 어제보다 더워.
오늘이 어제보다 덥습니다.

Coverage 📈

We have test-covered, and will test-cover, the following cases. Please feel free to contribute if you feel like you could cover more of these cases.

• -ㄴ대요
• -게
• -어
• -이야
• -마
• -봐
• -대?
• -어?
• -시어?
• -때?
• 동모음 탈락
• ㄷ 불규칙
• ㅅ 불규칙
• ㅎ 불규칙
• 오 불규칙
• 가라 불규칙
• 너라 불규칙
• 으 불규칙
• 르 불규칙
• 우 불규칙
• ㅂ 불규칙
• ... (more to be added)

Hosting the interactive demo

You can either host the interactive demo locally (you first have to sign up for papago API to get your secrets)

export NAVER_CLIENT_ID = ...
export NAVER_CLIENT_SECRET = ...
# host the demo via streamlit
streamlit run main_deploy.py

Or just visit the demo we are hosting for you

What Politely can't 🙅

politely's Styler cannnot take contexts into account because its conjugation algorithm is fundamentally rule-based. The algorithm is nothing but a chain of glorified if-else's. As a consequence of this, Styler can't disambiguate context-dependent conjugations, like so:

# 권유 / 청유의 차이는 맥락에 의존
print(styler("저는 쓰레기를 주워요.", 3))
print(styler("자, 같이 쓰레기를 주워요.", 3))

저는 쓰레기를 줍습니다.
자, 같이 쓰레기를 줍습니다. (should be "자, 같이 쓰레기를 주웁시다")

# 이르 + 어 -> 이르러/일러 또한 맥락에 의존
print(styler("하지 말라고 일렀다.", 3))
print(styler("정상에 이르렀다.", 3))

하지 말라고 일렀습니다.
정상에 일렀습니다. (should be "정상에 이르렀습니다")

By whom? 👏

• funded by: Faculty of Oriental Studies at the University of Oxford
• led & developed by: Jieun Kiaer (Associate Professor of Korean Language and Linguistics at the University of Oxford)
• co-developed by: Research assistant Eu-Bin KIM (Msc. in Applied Linguistics at the University of Oxford, Bsc. in AI at the University of Manchester )