added docs to rename transform

Author: eodole

bayesflow/adapters/transforms/rename.py

@@ -7,6 +7,23 @@
 
 @serializable(package="bayesflow.adapters")
 class Rename(Transform):
+    """
+    Transform to rename keys in data dictionary. Useful to rename variables to match those required by 
+    approximator. This transform can only rename one variable at a time. 
+
+    Parameters: 
+        - from_key: str of variable name that should be renamed 
+        - to_key: str representing new name 
+    
+    Example: 
+        adapter = (
+            bf.adapters.Adapter()
+
+            # rename the variables to match the required approximator inputs
+            .rename("theta", "inference_variables")
+            .rename("x", "inference_conditions")
+        )
+    """
     def __init__(self, from_key: str, to_key: str):
         super().__init__()
         self.from_key = from_key