aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/basemodel/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/basemodel/__init__.py')
-rw-r--r--src/basemodel/__init__.py36
1 files changed, 36 insertions, 0 deletions
diff --git a/src/basemodel/__init__.py b/src/basemodel/__init__.py
new file mode 100644
index 0000000..7287df4
--- /dev/null
+++ b/src/basemodel/__init__.py
@@ -0,0 +1,36 @@
+"""
+base-model - HydroRoll TRPG NER 模型 SDK
+
+这是一个用于 TRPG(桌上角色扮演游戏)日志命名实体识别的 Python SDK。
+
+基本用法:
+ >>> from basemodel import TRPGParser
+ >>> parser = TRPGParser()
+ >>> result = parser.parse("风雨 2024-06-08 21:44:59 剧烈的疼痛...")
+ >>> print(result)
+ {'metadata': {'speaker': '风雨', 'timestamp': '2024-06-08 21:44:59'}, 'content': [...]}
+
+训练功能(需要额外安装):
+ >>> pip install base-model[train]
+ >>> from basemodel.training import train_ner_model
+ >>> train_ner_model(conll_data="./data", output_dir="./model")
+"""
+
+from basemodel.inference import TRPGParser, parse_line, parse_lines
+
+try:
+ from importlib.metadata import version
+ __version__ = version("base-model")
+except Exception:
+ __version__ = "0.1.0.dev"
+
+__all__ = [
+ "__version__",
+ "TRPGParser",
+ "parse_line",
+ "parse_lines",
+]
+
+
+def get_version():
+ return __version__