Merge pull request #12 from CyberAgentAILab/feat/pypi

Add workflow to publish package

Author: TomeHirata

.github/workflows/publish.yml

@@ -0,0 +1,34 @@
+name: Publish Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Publish package to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          twine upload dist/*

docs/source/get_started.rst

@@ -79,7 +79,7 @@ A convenience function is available to visualize distribution effects. This meth
    :align: center
 
 To initialize the adjusted distribution function, the base model for conditional distribution function needs to be passed.
-In the following example, we use Logistic Regression.
+In the following example, we use Logistic Regression. Please make sure that your base model implements `fit` and `predict_proba` methods.
 
 .. code-block:: python