koalanlp / scala-support

한국어 형태소 및 구문 분석기의 모음 KoalaNLP의 Scala 언어용 API입니다.

Version Matrix

KoalaNLP

Version API Doc 분석기별 품사비교표

MIT License nodejs-koalanlp py-koalanlp

소개

KoalaNLP는 한국어 처리의 통합 인터페이스를 지향하는 Java/Kotlin/Scala Library입니다.

이 프로젝트는 KoalaNLP를 Scala에서 편하게 사용할 수 있도록 하는 여러 Implicit 기능을 담고 있습니다.

개선이나 추가 등을 하고 싶으시다면,

  • 개발이 직접 가능하시다면 pull request를 보내주세요. 테스트 후 반영할 수 있도록 하겠습니다.
  • 개발이 어렵다면 issue tracker에 등록해주세요. 검토 후 답변해드리겠습니다.

특징

KoalaNLP는 다음과 같은 특징을 가지고 있습니다.

  1. 복잡한 설정이 필요없는 텍스트 분석:

    모델은 자동으로 Maven으로 배포되기 때문에, 각 모델을 별도로 설치할 필요가 없습니다.

  2. 코드 2~3 줄로 수행하는 텍스트 처리:

    모델마다 다른 복잡한 설정 과정, 초기화 과정은 필요하지 않습니다. Dependency에 추가하고, 객체를 생성하고, 분석 메소드를 호출하는 3줄이면 끝납니다.

  3. 모델에 상관 없는 동일한 코드, 동일한 결과:

    모델마다 실행 방법, 실행 결과를 표현하는 형태가 다릅니다. KoalaNLP는 이를 정부 및 관계기관의 표준안에 따라 표준화합니다. 따라서 모델에 독립적으로 응용 프로그램 개발이 가능합니다.

  4. Java, Kotlin, Scala, Python 3, NodeJS에서 크게 다르지 않은 코드:

    KoalaNLP는 여러 프로그래밍 언어에서 사용할 수 있습니다. 어디서 개발을 하더라도 크게 코드가 다르지 않습니다.

License 조항

이 프로젝트 자체(KoalaNLP-core, koalanlp-scala)와 인터페이스 통합을 위한 코드는 소스코드에 저작권 귀속에 대한 별도 지시사항이 없는 한 v1.8.0부터 MIT License을 따르며, 원본 분석기의 License와 저작권은 각 저작권자가 지정한 바를 따릅니다.

단, GPL의 저작권 조항에 따라, GPL 하에서 이용이 허가되는 패키지들의 저작권은 해당 저작권 규정을 따릅니다.

  • Hannanum 및 NLP_HUB: GPL v3
  • KKMA: GPL v2 (GPL v2를 따르지 않더라도, 상업적 이용시 별도 협의 가능)
  • KOMORAN 3.x: Apache License 2.0
  • Open Korean Text: Apache License 2.0
  • SEunjeon: Apache License 2.0
  • 아리랑: Apache License 2.0
  • RHINO: GPL v3 (참고: 다운로드 위치별로 조항 상이함)
  • Daon: 지정된 조항 없음
  • ETRI: 별도 API 키 발급 동의 필요
  • Khaiii: Apache License 2.0
  • UTagger: 교육 및 연구용으로 사용시 제한 없음. 상업용인 경우 울산대와 기술이전 등의 유료 협약 필요

사용방법

상세한 사용법은 Usage 또는 Kotlin API Doc, Scala Support API Doc을 참고하십시오.

Dependency 추가

Java 패키지 목록

패키지명 설명 버전 License (원본)
koalanlp-scala Scala를 위한 편의기능 (Implicit conversion 등) 2.11 Version
2.12 Version
2.13 Version
MIT
koalanlp-kmr 코모란 Wrapper / 분석범위: 형태소 Java Version Apache 2.0
koalanlp-eunjeon 은전한닢 Wrapper / 분석범위: 형태소 2-3 Java Version Apache 2.0
koalanlp-arirang 아리랑 Wrapper / 분석범위: 형태소 2-1 Java Version Apache 2.0
koalanlp-rhino RHINO Wrapper / 분석범위: 형태소 2-1 Java Version GPL v3
koalanlp-daon Daon Wrapper / 분석범위: 형태소 2-1 Java Version MIT(별도 지정 없음)
koalanlp-khaiii Kakao Khaiii Wrapper / 분석범위: 형태소 2-4 Java Version Apache 2.0
koalanlp-utagger 울산대 UTagger Wrapper / 분석범위: 형태소 2-5 Java Version 교육/연구용 무료, 상업용 별도협약
koalanlp-okt Open Korean Text Wrapper / 분석범위: 문장분리, 형태소 2-3 Java Version Apache 2.0
koalanlp-kkma 꼬꼬마 Wrapper / 분석범위: 형태소, 의존구문 2-1 Java Version GPL v2
koalanlp-hnn 한나눔 Wrapper / 분석범위: 문장분리, 형태소, 구문분석, 의존구문 2-1 Java Version GPL v3
koalanlp-etri ETRI Open API Wrapper / 분석범위: 형태소, 구문분석, 의존구문, 개체명, 의미역 Java Version MIT2-2

주2-1 꼬꼬마, 한나눔, 아리랑, RHINO 분석기는 타 분석기와 달리 Maven repository에 등재되어 있지 않아, 원래는 수동으로 직접 추가하셔야 합니다. 이 점이 불편하다는 것을 알기에, KoalaNLP는 assembly 형태로 해당 패키지를 포함하여 배포하고 있습니다. 포함된 패키지를 사용하려면, assembly classifier를 사용하십시오. "assembly" classifier가 지정되지 않으면, 각 분석기 라이브러리가 빠진 채로 dependency가 참조됩니다.

주2-2 ETRI의 경우 Open API를 접근하기 위한 코드 부분은 KoalaNLP의 License 정책에 귀속되지만, Open API 접근 이후의 사용권에 관한 조항은 ETRI에서 별도로 정한 바를 따릅니다. 따라서, ETRI의 사용권 조항에 동의하시고 키를 발급하셔야 하며, 다음 위치에서 발급을 신청할 수 있습니다: 키 발급 신청

주2-3 은전한닢과 Open Korean Text는 원본 분석기가 Scala 2.12에서 개발되어 있어, Scala 2.12 이상만 지원합니다.

주2-4 Khaiii 분석기의 경우는 Java가 아닌 C++로 구현되어 사용 전 분석기의 설치가 필요합니다. Python3.6 및 CMake 3.10+만 설치되어 있다면 설치 자체가 복잡한 편은 아니니 여기를 참조하여 설치해보세요. 참고로, KoalaNLP가 Travis CI에서 패키지를 자동 테스트하기 위해 구현된 bash script는 여기에 있습니다.

주2-5 UTagger 분석기의 경우에도 C/C++로 구현되어, 사용 전 분석기의 설치가 필요합니다. 윈도우와 리눅스(우분투, CentOS)용 라이브러리 파일만 제공되며, 설치 방법은 여기를 참조하십시오.

실행환경

  • KoalaNLP의 모든 코드는 Java 11(Scala 2.11), Java 13(Scala 2.12, 2.13)을 기준으로 컴파일되고 테스트 되었습니다.

SBT

(버전은 Latest Release 기준입니다. SNAPSHOT을 사용하시려면, latest.integration을 사용하세요.)

val koalaScalaVer = "2.1.0"
val koalaVer = "2.1.2"

// Scala support 추가
libraryDependencies += "kr.bydelta" %% "koalanlp-scala" % koalaScalaVer

// 코모란 분석기의 경우
resolvers += "jitpack" at "https://jitpack.io/"
libraryDependencies += "kr.bydelta" % "koalanlp-kmr" % koalaVer

// 은전한닢 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-eunjeon" % koalaVer

// 아리랑 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-arirang" % "2.1.3" classifier "assembly"

// RHINO 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-rhino" % "2.1.3" classifier "assembly"

// Daon 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-daon" % "2.1.3" classifier "assembly"

// Open Korean Text 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-okt" % koalaVer

// 꼬꼬마 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-kkma" % "2.1.3" classifier "assembly"

// 한나눔 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-hannanum" % "2.1.3" classifier "assembly"

// ETRI 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-etri" % koalaVer

// ETRI 분석기의 경우
libraryDependencies += "kr.bydelta" % "koalanlp-etri" % koalaVer

// Khaiii 분석기의 경우 (Khaiii C++ 별도 설치 필요)
resolvers += Resolver.JCenterRepository
libraryDependencies += "kr.bydelta" % "koalanlp-khaiii" % koalaVer

// UTagger 분석기의 경우 (UTagger C++ 별도 설치 필요)
resolvers += Resolver.JCenterRepository
libraryDependencies += "kr.bydelta" % "koalanlp-utagger" % koalaVer