updates to deps; add readme to __init__

aalok-sathe · Nov 21, 2023 · 0e944d7 · 0e944d7
1 parent 0da7a77
commit 0e944d7
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 9 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,19 +18,30 @@ transformers = {version = "^4.20.1", optional = true}
 openai = {version = "^0.23.0", optional = true}
 kenlm = {version = "^0.2.0", optional = true}
 
-[tool.poetry.dev-dependencies]
-ipython = "^8.4.0"
-ipykernel = "^6.15.1"
-ipywidgets = "^7.7.1"
-pytest = "^7.2.0"
-black = {version = "^22.6.0", allow-prereleases = true}
-
 
 [tool.poetry.extras]
 transformers = ["transformers", "torch"]
 openai = ["openai"]
 kenlm = ["kenlm"]
 
+
+[tool.poetry.group.docs]
+optional = true
+
+[tool.poetry.group.dev]
+optional = true
+
+[tool.poetry.group.docs.dependencies]
+pdoc = "^14.1.0"
+
+[tool.poetry.group.dev.dependencies]
+ipython = "^8.4.0"
+ipykernel = "^6.15.1"
+ipywidgets = "^7.7.1"
+pytest = "^7.2.0"
+black = "^22.6.0"
+
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"
diff --git a/surprisal/__init__.py b/surprisal/__init__.py
@@ -1,3 +1,7 @@
+"""
+.. include:: ../README.md
+"""
+
 from surprisal.model import (
     AutoHuggingFaceModel,
     AutoTransformerModel,