Skip to main content

An explainable politeness styler for the Korean Language

Project description

Politely

Open in Streamlit Open In Colab Hits PyPI version

Politely is an explainable politeness styler for the Korean language
image

Quick Start ๐Ÿš€

1๏ธโƒฃ Install politely

pip3 install politely

2๏ธโƒฃ Speak politely with Styler

First, split your text into sentences with whatever tools you prefer. Here, we use kiwipiepy for the sake of demonstration:

from kiwipiepy import Kiwi
# an excerpt from ๋™๋ฐฑ๊ฝƒ (๊น€์œ ์ •)
text = """์ž”์†Œ๋ฆฌ๋ฅผ ๋‘๋ฃจ ๋Š˜์–ด๋†“๋‹ค๊ฐ€ ๋‚จ์ด ๋“ค์„๊นŒ๋ด ์†์œผ๋กœ ์ž…์„ ํ‹€์–ด๋ง‰๊ณ ๋Š” ๊ทธ ์†์—์„œ ๊น”๊น”๋Œ„๋‹ค. ๋ณ„๋กœ ์šฐ์Šค์šธ ๊ฒƒ๋„ ์—†๋Š”๋ฐ ๋‚ ์”จ๊ฐ€ ํ’€๋ฆฌ๋”๋‹ˆ ์ด ๋†ˆ์˜ ๊ณ„์ง‘์• ๊ฐ€ ๋ฏธ์ณค๋‚˜ ํ•˜๊ณ  ์˜์‹ฌํ•˜์˜€๋‹ค.
๊ฒŒ๋‹ค๊ฐ€ ์กฐ๊ธˆ ๋’ค์—๋Š” ์ œ ์ง‘๊ป˜๋ฅผ ํ• ๊ธˆํ• ๊ธˆ ๋Œ์•„๋ณด๋”๋‹ˆ ํ–‰์ฃผ์น˜๋งˆ์˜ ์†์œผ๋กœ ๊ผˆ๋˜ ๋ฐ”๋ฅธ์†์„ ๋ฝ‘์•„์„œ ๋‚˜์˜ ํ„ฑ๋ฐ‘์œผ๋กœ ๋ถˆ์‘ฅ ๋‚ด๋ฏธ๋Š” ๊ฒƒ์ด๋‹ค. 
์–ธ์ œ ๊ตฌ์› ๋Š”์ง€ ๋”์šด ๊น€์ด ํ™ฑ ๋ผ์น˜๋Š” ๊ตต์€ ๊ฐ์ž ์„ธ ๊ฐœ๊ฐ€ ์†์— ๋ฟŒ๋“ฏ์ด ์ฅ์˜€๋‹ค. "๋Š ์ง‘์—” ์ด๊ฑฐ ์—†์ง€?" ํ•˜๊ณ  ์ƒ์ƒ‰์žˆ๋Š” ํฐ์†Œ๋ฆฌ๋ฅผ ํ•˜๊ณ ๋Š” ์ œ๊ฐ€ ์ค€ ๊ฒƒ์„ ๋‚จ์ด ์•Œ๋ฉด์€ ํฐ์ผ๋‚ ํ…Œ๋‹ˆ ์—ฌ๊ธฐ์„œ ์–ผ๋ฅธ ๋จน์–ด ๋ฒ„๋ฆฌ๋ž€๋‹ค.
๊ทธ๋ฆฌ๊ณ  ๋˜ ํ•˜๋Š” ์†Œ๋ฆฌ๊ฐ€, "๋„ˆ ๋ด„๊ฐ์ž๊ฐ€ ๋ง›์žˆ๋‹จ๋‹ค." "๋‚œ ๊ฐ์ž ์•ˆ ๋จน๋Š”๋‹ค. ๋„ˆ๋‚˜ ๋จน์–ด๋ผ." ๋‚˜๋Š” ๊ณ ๊ฐœ๋„ ๋Œ๋ฆฌ์ง€ ์•Š๊ณ  ์ผํ•˜๋˜ ์†์œผ๋กœ ๊ทธ ๊ฐ์ž๋ฅผ ๋„๋กœ ์–ด๊นจ ๋„ˆ๋จธ๋กœ ์‘ฅ ๋ฐ€์–ด ๋ฒ„๋ ธ๋‹ค.
๊ทธ๋žฌ๋”๋‹ˆ ๊ทธ๋ž˜๋„ ๊ฐ€๋Š” ๊ธฐ์ƒ‰์ด ์—†๊ณ , ๋ฟ๋งŒ ์•„๋‹ˆ๋ผ ์Œ”๊ทผ์Œ”๊ทผํ•˜๊ณ  ์‹ฌ์ƒ์น˜ ์•Š๊ฒŒ ์ˆจ์†Œ๋ฆฌ๊ฐ€ ์ ์  ๊ฑฐ์น ์–ด์ง„๋‹ค. ์ด๊ฑด ๋˜ ๋ญ์•ผ ์‹ถ์–ด์„œ ๊ทธ๋•Œ์—์•ผ ๋น„๋กœ์†Œ ๋Œ์•„๋‹ค๋ณด๋‹ˆ ๋‚˜๋Š” ์ฐธ์œผ๋กœ ๋†€๋ž๋‹ค.
์šฐ๋ฆฌ๊ฐ€ ์ด ๋™๋„ค์— ๋“ค์–ด์˜จ ๊ฒƒ์€ ๊ทผ ์‚ผ๋…„์งธ ๋˜์–ด์˜ค์ง€๋งŒ ์—ฌํƒœ๊ป ๊ฐ€๋ฌด์žก์žกํ•œ ์ ์ˆœ์ด์˜ ์–ผ๊ตด์ด ์ด๋ ‡๊ฒŒ๊นŒ์ง€ ํ™๋‹น๋ฌด์ฒ˜๋Ÿผ ์ƒˆ๋นจ๊ฐœ์ง„ ๋ฒ•์ด ์—†์—ˆ๋‹ค.
๊ฒŒ๋‹ค๊ฐ€ ๋ˆˆ์— ๋…์„ ์˜ฌ๋ฆฌ๊ณ  ํ•œ์ฐธ ๋‚˜๋ฅผ ์š”๋ ‡๊ฒŒ ์˜์•„๋ณด๋”๋‹ˆ ๋‚˜์ค‘์—๋Š” ๋ˆˆ๋ฌผ๊นŒ์ง€ ์–ด๋ฆฌ๋Š” ๊ฒƒ์ด ์•„๋‹ˆ๋ƒ.
๊ทธ๋ฆฌ๊ณ  ๋ฐ”๊ตฌ๋‹ˆ๋ฅผ ๋‹ค์‹œ ์ง‘์–ด๋“ค๋”๋‹ˆ ์ด๋ฅผ ๊ผญ ์•…๋ฌผ๊ณ ๋Š” ์—Ž์–ด์งˆ ๋“ฏ ์ž๋น ์งˆ ๋“ฏ ๋…ผ๋‘‘์œผ๋กœ ํšกํ•˜๊ฒŒ ๋‹ฌ์•„๋‚˜๋Š” ๊ฒƒ์ด๋‹ค."""
kiwi = Kiwi()
sents = [sent.text.strip() for sent in kiwi.split_into_sents(text)]

Instantiate a styler object, and style your sentences in a polite or formal manner with styler:

from politely import Styler
from pprint import pprint
styler = Styler()
pprint(" ".join(styler(sents, 2)))  # 2 = polite
pprint(" ".join(styler(sents, 3)))  # 3 = formal
('์ž”์†Œ๋ฆฌ๋ฅผ ๋‘๋ฃจ ๋Š˜์–ด๋†“๋‹ค๊ฐ€ ๋‚จ์ด ๋“ค์„๊นŒ ๋ด ์†์œผ๋กœ ์ž…์„ ํ‹€์–ด๋ง‰๊ณ ๋Š” ๊ทธ ์†์—์„œ ๊น”๊น”๋Œ€์š”. ๋ณ„๋กœ ์šฐ์Šค์šธ ๊ฒƒ๋„ ์—†๋Š”๋ฐ ๋‚ ์”จ๊ฐ€ ํ’€๋ฆฌ๋”๋‹ˆ ์ด ๋†ˆ์˜ '
 '๊ณ„์ง‘์• ๊ฐ€ ๋ฏธ์ณค๋‚˜ ํ•˜๊ณ  ์˜์‹ฌํ–ˆ์–ด์š”. ๊ฒŒ๋‹ค๊ฐ€ ์กฐ๊ธˆ ๋’ค์—๋Š” ์ œ ์ง‘๊ป˜๋ฅผ ํ•  ๊ธˆํ•  ๊ธˆ ๋Œ์•„๋ณด๋”๋‹ˆ ํ–‰์ฃผ์น˜๋งˆ์˜ ์†์œผ๋กœ ๊ผˆ๋˜ ๋ฐ”๋ฅธ ์†์„ ๋ฝ‘์•„์„œ ์ œ ํ„ฑ '
 '๋ฐ‘์œผ๋กœ ๋ถˆ์‘ฅ ๋‚ด๋ฏธ๋Š” ๊ฒŒ์—์š”. ์–ธ์ œ ๊ตฌ์› ๋Š”์ง€ ๋”์šด ๊น€์ด ํ™ฑ ๋ผ์น˜๋Š” ๊ตต์€ ๊ฐ์ž ์„ธ ๊ฐœ๊ฐ€ ์†์— ๋ฟŒ๋“ฏ์ด ์ฅ์˜€์–ด์š”. "๋Š ์ง‘์—๋Š” ์ด ๊ฑฐ ์—†์ฃ ? '
 '"ํ•˜๊ณ  ์ƒ์ƒ‰ ์žˆ๋Š” ํฐ ์†Œ๋ฆฌ๋ฅผ ํ•˜๊ณ ๋Š” ์ œ๊ฐ€ ์ค€ ๊ฒƒ์„ ๋‚จ์ด ์•Œ๋ฉด์€ ํฐ์ผ ๋‚  ํ…Œ๋‹ˆ ์—ฌ๊ธฐ์„œ ์–ผ๋ฅธ ๋จน์–ด ๋ฒ„๋ฆฌ๋ž˜์š”. ๊ทธ๋ฆฌ๊ณ  ๋˜ ํ•˜๋Š” ์†Œ๋ฆฌ๊ฐ€,"๋‹น์‹  '
 '๋ด„ ๊ฐ์ž๊ฐ€ ๋ง›์žˆ์–ด์š”. ""๋‚œ ๊ฐ์ž ์•ˆ ๋จน์–ด์š”. ๋‹น์‹ ์ด๋‚˜ ๋จน์–ด์š”. "์ €๋Š” ๊ณ ๊ฐœ๋„ ๋Œ๋ฆฌ์ง€ ์•Š๊ณ  ์ผํ•˜๋˜ ์†์œผ๋กœ ๊ทธ ๊ฐ์ž๋ฅผ ๋„๋กœ ์–ด๊นจ ๋„ˆ๋จธ๋กœ ์‘ฅ '
 '๋ฐ€์–ด ๋ฒ„๋ ธ์–ด์š”. ๊ทธ๋žฌ๋”๋‹ˆ ๊ทธ๋ž˜๋„ ๊ฐ€๋Š” ๊ธฐ์ƒ‰์ด ์—†๊ณ , ๋ฟ๋งŒ ์•„๋‹ˆ๋ผ ์Œ”๊ทผ์Œ”๊ทผํ•˜๊ณ  ์‹ฌ์ƒํ•˜์ง€ ์•Š๊ฒŒ ์ˆจ์†Œ๋ฆฌ๊ฐ€ ์ ์  ๊ฑฐ์น ์–ด์ ธ์š”. ์ด๊ฑฐ๋Š” ๋˜ ๋ญ์•ผ '
 '์‹ถ์–ด์„œ ๊ทธ ๋•Œ์—์•ผ ๋น„๋กœ์†Œ ๋Œ์•„๋‹ค๋ณด๋‹ˆ ์ €๋Š” ์ฐธ์œผ๋กœ ๋†€๋ž์–ด์š”. ์ €ํฌ๊ฐ€ ์ด ๋™๋„ค์— ๋“ค์–ด์˜จ ๊ฒƒ์€ ๊ทผ ์‚ผ ๋…„์งธ ๋ผ ์˜ค์ง€๋งŒ ์—ฌํƒœ๊ป ๊ฐ€๋ฌด์žก์žกํ•œ ์ ์ˆ˜๋Š” '
 '์ด์˜ ์–ผ๊ตด์ด ์ด๋ ‡๊ฒŒ๊นŒ์ง€ ํ™๋‹น๋ฌด์ฒ˜๋Ÿผ ์ƒˆ๋นจ๊ฐœ์ง„ ๋ฒ•์ด ์—†์—ˆ์–ด์š”. ๊ฒŒ๋‹ค๊ฐ€ ๋ˆˆ์— ๋…์„ ์˜ฌ๋ฆฌ๊ณ  ํ•œ์ฐธ ์ €๋ฅผ ์š”๋ ‡๊ฒŒ ์˜์•„๋ณด๋”๋‹ˆ ๋‚˜์ค‘์—๋Š” ๋ˆˆ๋ฌผ๊นŒ์ง€ ์–ด๋ฆฌ๋Š” '
 '๊ฒŒ ์•„๋…€์š”. ๊ทธ๋ฆฌ๊ณ  ๋ฐ”๊ตฌ๋‹ˆ๋ฅผ ๋‹ค์‹œ ์ง‘์–ด ๋“ค๋”๋‹ˆ ์ด๋ฅผ ๊ผญ ์•…๋ฌผ๊ณ ๋Š” ์—Ž์–ด์งˆ ๋“ฏ ์ž๋น ์งˆ ๋“ฏ ๋…ผ๋‘‘์œผ๋กœ ํšกํ•˜๊ฒŒ ๋‹ฌ์•„๋‚˜๋Š” ๊ฒŒ์—์š”.')
('์ž”์†Œ๋ฆฌ๋ฅผ ๋‘๋ฃจ ๋Š˜์–ด๋†“๋‹ค๊ฐ€ ๋‚จ์ด ๋“ค์„๊นŒ ๋ด ์†์œผ๋กœ ์ž…์„ ํ‹€์–ด๋ง‰๊ณ ๋Š” ๊ทธ ์†์—์„œ ๊น”๊น”๋Œ‘๋‹ˆ๋‹ค. ๋ณ„๋กœ ์šฐ์Šค์šธ ๊ฒƒ๋„ ์—†๋Š”๋ฐ ๋‚ ์”จ๊ฐ€ ํ’€๋ฆฌ๋”๋‹ˆ ์ด ๋†ˆ์˜ '
 '๊ณ„์ง‘์• ๊ฐ€ ๋ฏธ์ณค๋‚˜ ํ•˜๊ณ  ์˜์‹ฌํ–ˆ์Šต๋‹ˆ๋‹ค. ๊ฒŒ๋‹ค๊ฐ€ ์กฐ๊ธˆ ๋’ค์—๋Š” ์ œ ์ง‘๊ป˜๋ฅผ ํ•  ๊ธˆํ•  ๊ธˆ ๋Œ์•„๋ณด๋”๋‹ˆ ํ–‰์ฃผ์น˜๋งˆ์˜ ์†์œผ๋กœ ๊ผˆ๋˜ ๋ฐ”๋ฅธ ์†์„ ๋ฝ‘์•„์„œ ์ œ ํ„ฑ '
 '๋ฐ‘์œผ๋กœ ๋ถˆ์‘ฅ ๋‚ด๋ฏธ๋Š” ๊ฒ๋‹ˆ๋‹ค. ์–ธ์ œ ๊ตฌ์› ๋Š”์ง€ ๋”์šด ๊น€์ด ํ™ฑ ๋ผ์น˜๋Š” ๊ตต์€ ๊ฐ์ž ์„ธ ๊ฐœ๊ฐ€ ์†์— ๋ฟŒ๋“ฏ์ด ์ฅ์˜€์Šต๋‹ˆ๋‹ค. "๋Š ์ง‘์—๋Š” ์ด ๊ฑฐ '
 '์—†์Šต๋‹ˆ๊นŒ? "ํ•˜๊ณ  ์ƒ์ƒ‰ ์žˆ๋Š” ํฐ ์†Œ๋ฆฌ๋ฅผ ํ•˜๊ณ ๋Š” ์ œ๊ฐ€ ์ค€ ๊ฒƒ์„ ๋‚จ์ด ์•Œ๋ฉด์€ ํฐ์ผ ๋‚  ํ…Œ๋‹ˆ ์—ฌ๊ธฐ์„œ ์–ผ๋ฅธ ๋จน์–ด ๋ฒ„๋ฆฌ๋ž๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  ๋˜ ํ•˜๋Š” '
 '์†Œ๋ฆฌ๊ฐ€,"๋‹น์‹  ๋ด„ ๊ฐ์ž๊ฐ€ ๋ง›์žˆ์Šต๋‹ˆ๋‹ค. ""๋‚œ ๊ฐ์ž ์•ˆ ๋จน์Šต๋‹ˆ๋‹ค. ๋‹น์‹ ์ด๋‚˜ ๋จน์‹ญ์‹œ์˜ค. "์ €๋Š” ๊ณ ๊ฐœ๋„ ๋Œ๋ฆฌ์ง€ ์•Š๊ณ  ์ผํ•˜๋˜ ์†์œผ๋กœ ๊ทธ ๊ฐ์ž๋ฅผ '
 '๋„๋กœ ์–ด๊นจ ๋„ˆ๋จธ๋กœ ์‘ฅ ๋ฐ€์–ด ๋ฒ„๋ ธ์Šต๋‹ˆ๋‹ค. ๊ทธ๋žฌ๋”๋‹ˆ ๊ทธ๋ž˜๋„ ๊ฐ€๋Š” ๊ธฐ์ƒ‰์ด ์—†๊ณ , ๋ฟ๋งŒ ์•„๋‹ˆ๋ผ ์Œ”๊ทผ์Œ”๊ทผํ•˜๊ณ  ์‹ฌ์ƒํ•˜์ง€ ์•Š๊ฒŒ ์ˆจ์†Œ๋ฆฌ๊ฐ€ ์ ์  '
 '๊ฑฐ์น ์–ด์ง‘๋‹ˆ๋‹ค. ์ด๊ฑฐ๋Š” ๋˜ ๋ญ์•ผ ์‹ถ์–ด์„œ ๊ทธ ๋•Œ์—์•ผ ๋น„๋กœ์†Œ ๋Œ์•„๋‹ค๋ณด๋‹ˆ ์ €๋Š” ์ฐธ์œผ๋กœ ๋†€๋ž์Šต๋‹ˆ๋‹ค. ์ €ํฌ๊ฐ€ ์ด ๋™๋„ค์— ๋“ค์–ด์˜จ ๊ฒƒ์€ ๊ทผ ์‚ผ ๋…„์งธ ๋ผ '
 '์˜ค์ง€๋งŒ ์—ฌํƒœ๊ป ๊ฐ€๋ฌด์žก์žกํ•œ ์ ์ˆ˜๋Š” ์ด์˜ ์–ผ๊ตด์ด ์ด๋ ‡๊ฒŒ๊นŒ์ง€ ํ™๋‹น๋ฌด์ฒ˜๋Ÿผ ์ƒˆ๋นจ๊ฐœ์ง„ ๋ฒ•์ด ์—†์—ˆ์Šต๋‹ˆ๋‹ค. ๊ฒŒ๋‹ค๊ฐ€ ๋ˆˆ์— ๋…์„ ์˜ฌ๋ฆฌ๊ณ  ํ•œ์ฐธ ์ €๋ฅผ ์š”๋ ‡๊ฒŒ '
 '์˜์•„๋ณด๋”๋‹ˆ ๋‚˜์ค‘์—๋Š” ๋ˆˆ๋ฌผ๊นŒ์ง€ ์–ด๋ฆฌ๋Š” ๊ฒŒ ์•„๋‹™๋””๋‹ค. ๊ทธ๋ฆฌ๊ณ  ๋ฐ”๊ตฌ๋‹ˆ๋ฅผ ๋‹ค์‹œ ์ง‘์–ด ๋“ค๋”๋‹ˆ ์ด๋ฅผ ๊ผญ ์•…๋ฌผ๊ณ ๋Š” ์—Ž์–ด์งˆ ๋“ฏ ์ž๋น ์งˆ ๋“ฏ ๋…ผ๋‘‘์œผ๋กœ '
 'ํšกํ•˜๊ฒŒ ๋‹ฌ์•„๋‚˜๋Š” ๊ฒ๋‹ˆ๋‹ค.')

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
image

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 )

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

politely-3.1.0-py3-none-any.whl (7.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page