Fix UML permissions from forks / Run only on merge to main (#967)

* change repo and python file change to kick off * comment to check for failure * using the repo * delete to trigger * the previous trigger * push up again * check for the owner being pymc-labs * remove unused * only run after merge to main
pymc-labs · Sep 10, 2024 · 671ed14 · 671ed14
1 parent 886342d
commit 671ed14
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 6 deletions.
diff --git a/.github/workflows/uml.yml b/.github/workflows/uml.yml
@@ -1,17 +1,15 @@
 name: Update the UML Diagrams
 
 on:
-  pull_request:
-    branches: [main]
-    paths:
-      - "pymc_marketing/**"
   push:
+    types: [closed]
     branches: [main]
     paths:
       - "pymc_marketing/**"
 
 jobs:
   build:
+    if: github.event.pull_request.head.repo.owner.login == 'pymc-labs'
     runs-on: ubuntu-latest
     permissions: write-all
     steps:

diff --git a/docs/source/uml/classes_clv.png b/docs/source/uml/classes_clv.png
diff --git a/docs/source/uml/classes_mmm.png b/docs/source/uml/classes_mmm.png
diff --git a/docs/source/uml/packages_clv.png b/docs/source/uml/packages_clv.png
diff --git a/docs/source/uml/packages_mmm.png b/docs/source/uml/packages_mmm.png
diff --git a/pymc_marketing/prior.py b/pymc_marketing/prior.py
@@ -66,7 +66,7 @@
     )
 
 Create a transformed hierarchical normal prior by using the `transform`
-parameter.
+parameter. Here the "sigmoid" transformation comes from `pm.math`.
 
 .. code-block:: python
 
@@ -242,7 +242,8 @@ class Prior:
         Only allowed for Normal distribution.
     transform : str, optional
         The name of the transform to apply to the variable after it is
-        created, by default None or no transform.
+        created, by default None or no transform. The transformation must
+        be available in either `pytensor.tensor` or `pymc.math`.
 
     """