kiui

Name	kiui JSON
Version	0.2.17 JSON
	download
home_page	https://github.com/ashawkey/kiuikit
Summary	A toolkit for 3D vision
upload_time	2025-07-20 03:49:55
maintainer	None
docs_url	None
author	kiui
requires_python	None
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <p align="center">
    <picture>
    <img alt="kiuikit_logo" src="docs/source/_static/logo.png" width="50%">
    </picture>
    </br>
    <b>Kiuikit</b>
    </br>
    <code>pip install kiui</code>
    &nbsp;&nbsp;&bull;&nbsp;&nbsp;
    <a href="https://kit.kiui.moe/">Documentation</a>
</p>

A toolkit for computer vision (especially 3D vision) tasks.

**Features**:
* Collection of useful & reusable code snippets.
* Always using lazy import so the code is not slowed down by `import kiui`.

### Install

```bash
# released
pip install kiui # install the minimal package
pip install kiui[full] # install optional dependencies

# latest
pip install git+https://github.com/ashawkey/kiuikit.git # only the minimal package
```

### Basic Usage

```python
import kiui

### quick inspection of array-like object
x = torch.tensor(...)
y = np.array(...)

kiui.lo(x)
kiui.lo(x, y) # support multiple objects
kiui.lo(kiui) # or any other object (just print with name)

### visualization tools
img_tensor = torch.rand(3, 256, 256) 
# tensor of [3, H, W], [1, H, W], [H, W] / array of [H, W ,3], [H, W, 1], [H, W] in [0, 1]
kiui.vis.plot_image(img)
kiui.vis.plot_image(img_tensor)

### mesh utils
from kiui.mesh import Mesh
mesh = Mesh.load('model.obj')
kiui.lo(mesh.v, mesh.f) # CUDA torch.Tensor
mesh.write('new.glb') # support exporting to GLB/GLTF too (texture embedded).
```

CLI tools:
```bash
# sr (Real-ESRGAN from https://github.com/ai-forever/Real-ESRGAN/tree/main)
python -m kiui.sr --help
python -m kiui.sr image.jpg --scale 2 # save to image_2x.jpg
kisr image.jpg --scale 2 # short cut cmd

# mesh format conversion (only for a single textured mesh in obj/glb)
python -m kiui.cli.convert input.obj output.glb
kico input.obj output.glb # short cut cmd
kico mesh_folder video_folder --in_fmt .glb --out_fmt .mp4 # render all glb meshes into rotating videos

# aesthetic predictor v2 (https://github.com/christophschuhmann/improved-aesthetic-predictor)
python -m kiui.cli.aes --help

# compare content of two directories
python -m kiui.cli.dircmp <dir1> <dir2>

# lock requirements.txt package versions based on current environment
python -m kiui.cli.lock_version <requirements.txt>

# render mesh with blender
python -m kiui.cli.blender_render --mesh input.glb --gpu 0 --depth --normal --pbr --camera --blend
python -m kiui.cli.blender_render --mesh input.glb --wireframe
```

GUI tools:
```bash
# open a GUI to render a mesh (extra dep: nvdiffrast)
python -m kiui.render --help
python -m kiui.render mesh.obj
python -m kiui.render mesh.glb --pbr # render with PBR (metallic + roughness)
python -m kiui.render mesh.obj --save_video out.mp4 --wogui # save 360 degree rotating video
kire --help # short cut cmd

# open a GUI to render and edit pose (openpose convention, controlnet compatible)
python -m kiui.poser --help
python -m kiui.poser --load 3head # load preset 3 headed skeleton
```

https://github.com/ashawkey/kiuikit/assets/25863658/d8cbcf0f-a6d8-4fa7-aee9-afbbf25ed167

> ["Seahourse3"](https://skfb.ly/6TwFv) by seanhepburn is licensed under [Creative Commons Attribution](http://creativecommons.org/licenses/by/4.0/).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ashawkey/kiuikit",
    "name": "kiui",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "kiui",
    "author_email": "ashawkey1999@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/07/9d/7c8eb9d604f490d6e00031a14eec8c770d9ce61a7c4c4bd194ce597ccf45/kiui-0.2.17.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n    <picture>\n    <img alt=\"kiuikit_logo\" src=\"docs/source/_static/logo.png\" width=\"50%\">\n    </picture>\n    </br>\n    <b>Kiuikit</b>\n    </br>\n    <code>pip install kiui</code>\n    &nbsp;&nbsp;&bull;&nbsp;&nbsp;\n    <a href=\"https://kit.kiui.moe/\">Documentation</a>\n</p>\n\nA toolkit for computer vision (especially 3D vision) tasks.\n\n**Features**:\n* Collection of useful & reusable code snippets.\n* Always using lazy import so the code is not slowed down by `import kiui`.\n\n### Install\n\n```bash\n# released\npip install kiui # install the minimal package\npip install kiui[full] # install optional dependencies\n\n# latest\npip install git+https://github.com/ashawkey/kiuikit.git # only the minimal package\n```\n\n### Basic Usage\n\n```python\nimport kiui\n\n### quick inspection of array-like object\nx = torch.tensor(...)\ny = np.array(...)\n\nkiui.lo(x)\nkiui.lo(x, y) # support multiple objects\nkiui.lo(kiui) # or any other object (just print with name)\n\n### visualization tools\nimg_tensor = torch.rand(3, 256, 256) \n# tensor of [3, H, W], [1, H, W], [H, W] / array of [H, W ,3], [H, W, 1], [H, W] in [0, 1]\nkiui.vis.plot_image(img)\nkiui.vis.plot_image(img_tensor)\n\n### mesh utils\nfrom kiui.mesh import Mesh\nmesh = Mesh.load('model.obj')\nkiui.lo(mesh.v, mesh.f) # CUDA torch.Tensor\nmesh.write('new.glb') # support exporting to GLB/GLTF too (texture embedded).\n```\n\nCLI tools:\n```bash\n# sr (Real-ESRGAN from https://github.com/ai-forever/Real-ESRGAN/tree/main)\npython -m kiui.sr --help\npython -m kiui.sr image.jpg --scale 2 # save to image_2x.jpg\nkisr image.jpg --scale 2 # short cut cmd\n\n# mesh format conversion (only for a single textured mesh in obj/glb)\npython -m kiui.cli.convert input.obj output.glb\nkico input.obj output.glb # short cut cmd\nkico mesh_folder video_folder --in_fmt .glb --out_fmt .mp4 # render all glb meshes into rotating videos\n\n# aesthetic predictor v2 (https://github.com/christophschuhmann/improved-aesthetic-predictor)\npython -m kiui.cli.aes --help\n\n# compare content of two directories\npython -m kiui.cli.dircmp <dir1> <dir2>\n\n# lock requirements.txt package versions based on current environment\npython -m kiui.cli.lock_version <requirements.txt>\n\n# render mesh with blender\npython -m kiui.cli.blender_render --mesh input.glb --gpu 0 --depth --normal --pbr --camera --blend\npython -m kiui.cli.blender_render --mesh input.glb --wireframe\n```\n\nGUI tools:\n```bash\n# open a GUI to render a mesh (extra dep: nvdiffrast)\npython -m kiui.render --help\npython -m kiui.render mesh.obj\npython -m kiui.render mesh.glb --pbr # render with PBR (metallic + roughness)\npython -m kiui.render mesh.obj --save_video out.mp4 --wogui # save 360 degree rotating video\nkire --help # short cut cmd\n\n# open a GUI to render and edit pose (openpose convention, controlnet compatible)\npython -m kiui.poser --help\npython -m kiui.poser --load 3head # load preset 3 headed skeleton\n```\n\nhttps://github.com/ashawkey/kiuikit/assets/25863658/d8cbcf0f-a6d8-4fa7-aee9-afbbf25ed167\n\n> [\"Seahourse3\"](https://skfb.ly/6TwFv) by seanhepburn is licensed under [Creative Commons Attribution](http://creativecommons.org/licenses/by/4.0/).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A toolkit for 3D vision",
    "version": "0.2.17",
    "project_urls": {
        "Homepage": "https://github.com/ashawkey/kiuikit"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4dde3b507807d3581500a5e9047c39738d9f9c3d278de0521e0c0347c3093bcc",
                "md5": "6e39f1d6211e61fecbc1d1b91928c786",
                "sha256": "d8aaa6641ee10c1f71eba1f99bb718a5c39410e70503c8667bec666a93a6fff4"
            },
            "downloads": -1,
            "filename": "kiui-0.2.17-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e39f1d6211e61fecbc1d1b91928c786",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3092765,
            "upload_time": "2025-07-20T03:49:53",
            "upload_time_iso_8601": "2025-07-20T03:49:53.813011Z",
            "url": "https://files.pythonhosted.org/packages/4d/de/3b507807d3581500a5e9047c39738d9f9c3d278de0521e0c0347c3093bcc/kiui-0.2.17-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "079d7c8eb9d604f490d6e00031a14eec8c770d9ce61a7c4c4bd194ce597ccf45",
                "md5": "1e4558959339ce26efbea8c7655eabf6",
                "sha256": "3b51c0cf13dcd4342f72b2802d45c93acd48d686ee670a5034de7e77a4cbe936"
            },
            "downloads": -1,
            "filename": "kiui-0.2.17.tar.gz",
            "has_sig": false,
            "md5_digest": "1e4558959339ce26efbea8c7655eabf6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3064584,
            "upload_time": "2025-07-20T03:49:55",
            "upload_time_iso_8601": "2025-07-20T03:49:55.776313Z",
            "url": "https://files.pythonhosted.org/packages/07/9d/7c8eb9d604f490d6e00031a14eec8c770d9ce61a7c4c4bd194ce597ccf45/kiui-0.2.17.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-20 03:49:55",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ashawkey",
    "github_project": "kiuikit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "kiui"
}