bump to 0.2.0

docs/source/conf.py

@@ -40,9 +40,9 @@
 ]
 
 # Pull documentation types from hints
-# autodoc_typehints = "both"
 autodoc_default_options = {
-    "member-order": "bysource",
+    "member-order": "bysource", # sort by source order
+    "special-members": '__init__', # also doc __init__
 }
 
 # Add any paths that contain templates here, relative to this directory.

kiui/utils.py

@@ -179,15 +179,15 @@ def read_image(
 
     Args:
         path (str): path to the image file.
-        mode (Literal["float", "uint8", "pil", "torch", "tensor"], optional): returned image format. Defaults to "float".
-            float - float32 numpy array, range [0, 1]
-            uint8 - uint8 numpy array, range [0, 255]
-            pil - PIL image
-            torch/tensor - float32 torch tensor, range [0, 1]
-        order (Literal["RGB", "RGBA", "BGR", "BGRA"], optional): channel order. Defaults to "RGB".
+        mode (Literal["float", "uint8", "pil", "torch", "tensor"], optional): returned image format. Defaults to "float".
+            float: float32 numpy array, range [0, 1];
+            uint8: uint8 numpy array, range [0, 255];
+            pil: PIL image;
+            torch/tensor: float32 torch tensor, range [0, 1];
+        order (Literal["RGB", "RGBA", "BGR", "BGRA"], optional): channel order. Defaults to "RGB".
     
     Note:
-        By default this function will convert RGBA image to white-background RGB image. Use `order="RGBA"` to keep the alpha channel.
+        By default this function will convert RGBA image to white-background RGB image. Use ``order="RGBA"`` to keep the alpha channel.
 
     Returns:
         Union[np.ndarray, PIL.Image, torch.Tensor]: the image array.

setup.py

@@ -3,7 +3,7 @@
 if __name__ == "__main__":
     setup(
         name="kiui",
-        version="0.1.12",
+        version="0.2.0",
         description="A toolkit for 3D vision",
         long_description=open("README.md", encoding="utf-8").read(),
         long_description_content_type="text/markdown",
@@ -50,6 +50,7 @@
                 'tyro',
                 'viser',
                 'pymeshlab',
+                'huggingface_hub',
             ],
         },
     )