| Name | jammy JSON |
| Version |
0.1.44
JSON |
| download |
| home_page | None |
| Summary | A Versatile ToolBox |
| upload_time | 2024-11-04 02:35:57 |
| maintainer | None |
| docs_url | None |
| author | Qin |
| requires_python | <3.12,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1 align="center"> Jammy (Jam) </h1>
<p align="center">
<a href="https://pypi.org/project/jammy/">
<img src="https://img.shields.io/pypi/v/jammy?style=for-the-badge" alt="PyPI" />
</a>
<a href="#">
<img src="https://img.shields.io/pypi/l/jammy?style=for-the-badge" alt="PyPI - License" />
</a>
<a href="https://github.com/qsh-zh/jam">
<img src="https://img.shields.io/badge/-github-grey?style=for-the-badge&logo=github" alt="GitHub code" />
</a>
<a href="https://gitlab.com/qsh.zh/jam">
<img src="https://img.shields.io/badge/-gitlab-grey?style=for-the-badge&logo=gitlab" alt="GitLab code" />
</a>
<a href="https://jammy.readthedocs.io/en/stable/index.html">
<img src="https://img.shields.io/readthedocs/jammy?style=for-the-badge" alt="Read the Docs" />
</a>
<a href="#">
<img src="https://img.shields.io/pypi/pyversions/jammy?style=for-the-badge" alt="PyPI - Python Version" />
</a>
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge" alt="Code style: black" />
</a>
<p align="center">
<i>A personal toolbox by <a href="https://qsh-zh.github.io/">Qsh.zh</a>.</i>
</p>
</p>
### Usage
#### setup
* For core package, run `pip install jammy`
* To access functions in `bin`
```shell
git clone https://gitlab.com/qsh.zh/jam.git --recursive
export PATH=<path_to_jam>/bin:$PATH
# run python program
jam-run main.py
jam-crun 1 main.py # use second nvidia gpu
```
#### sample of io
```python
import jammy.io as jio
from jamtorch.utils import as_numpy
jio.dump("ndarray.npz", np.arange(10))
jio.dump("foo.pkl", {"foo": as_numpy(torch.arange(10).cuda())})
ndarray = jio.load("ndarray.npz")
jio.load("foo.pkl")
model_dict = jio.load("checkpoint.pth")
```
```shell
$ jinspect-file foo.pkl
> python3
[ins] print(f1)
# content of foo.pkl
```
### Advanced Usage
* [A DDP pytorch training framework](https://jammy.readthedocs.io/en/stable/jamtorch.ddp.html)
* [Registry](https://jammy.readthedocs.io/en/stable/jammy.utils.html?highlight=registry#jammy.utils.registry.CallbackRegistry)
* TODO
### Etymology
* The naming is inspired from [Jyutping](https://en.wikipedia.org/wiki/Jyutping) of [Qin](https://en.wiktionary.org/wiki/%E6%AC%BD).
### MICS
* The package and framework are inspired from [Jacinle](https://github.com/vacancy/Jacinle) by [vacancy](https://github.com/vacancy), from which I learn and take utility functions shamelessly.
Raw data
{
"_id": null,
"home_page": null,
"name": "jammy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Qin",
"author_email": "qsh.zh27@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ec/b4/efee7d5172c9b8caa9f4e3ce11b19de75432fa721cb3a9613871d5870546/jammy-0.1.44.tar.gz",
"platform": null,
"description": "<h1 align=\"center\"> Jammy (Jam) </h1>\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/jammy/\">\n <img src=\"https://img.shields.io/pypi/v/jammy?style=for-the-badge\" alt=\"PyPI\" />\n </a>\n <a href=\"#\">\n <img src=\"https://img.shields.io/pypi/l/jammy?style=for-the-badge\" alt=\"PyPI - License\" />\n </a>\n <a href=\"https://github.com/qsh-zh/jam\">\n <img src=\"https://img.shields.io/badge/-github-grey?style=for-the-badge&logo=github\" alt=\"GitHub code\" />\n </a>\n <a href=\"https://gitlab.com/qsh.zh/jam\">\n <img src=\"https://img.shields.io/badge/-gitlab-grey?style=for-the-badge&logo=gitlab\" alt=\"GitLab code\" />\n </a>\n <a href=\"https://jammy.readthedocs.io/en/stable/index.html\">\n <img src=\"https://img.shields.io/readthedocs/jammy?style=for-the-badge\" alt=\"Read the Docs\" />\n </a>\n <a href=\"#\">\n <img src=\"https://img.shields.io/pypi/pyversions/jammy?style=for-the-badge\" alt=\"PyPI - Python Version\" />\n </a>\n <a href=\"https://github.com/psf/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge\" alt=\"Code style: black\" />\n </a>\n <p align=\"center\">\n <i>A personal toolbox by <a href=\"https://qsh-zh.github.io/\">Qsh.zh</a>.</i>\n </p>\n</p>\n\n### Usage\n\n#### setup\n\n* For core package, run `pip install jammy`\n* To access functions in `bin`\n```shell\ngit clone https://gitlab.com/qsh.zh/jam.git --recursive\nexport PATH=<path_to_jam>/bin:$PATH\n# run python program\njam-run main.py\njam-crun 1 main.py # use second nvidia gpu\n```\n\n\n#### sample of io\n```python\nimport jammy.io as jio\nfrom jamtorch.utils import as_numpy\njio.dump(\"ndarray.npz\", np.arange(10))\njio.dump(\"foo.pkl\", {\"foo\": as_numpy(torch.arange(10).cuda())})\nndarray = jio.load(\"ndarray.npz\")\njio.load(\"foo.pkl\")\nmodel_dict = jio.load(\"checkpoint.pth\")\n```\n```shell\n$ jinspect-file foo.pkl\n> python3\n[ins] print(f1)\n# content of foo.pkl\n\n```\n\n### Advanced Usage\n\n* [A DDP pytorch training framework](https://jammy.readthedocs.io/en/stable/jamtorch.ddp.html)\n* [Registry](https://jammy.readthedocs.io/en/stable/jammy.utils.html?highlight=registry#jammy.utils.registry.CallbackRegistry)\n* TODO\n\n### Etymology\n* The naming is inspired from [Jyutping](https://en.wikipedia.org/wiki/Jyutping) of [Qin](https://en.wiktionary.org/wiki/%E6%AC%BD).\n\n### MICS\n\n* The package and framework are inspired from [Jacinle](https://github.com/vacancy/Jacinle) by [vacancy](https://github.com/vacancy), from which I learn and take utility functions shamelessly.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Versatile ToolBox",
"version": "0.1.44",
"project_urls": {
"Documentation": "https://jammy.readthedocs.io/en/latest/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01c01b7b48bce79782cb5371c5c79666e8390783aebf6545171df3f38ceecc8e",
"md5": "09447e5c07867bbf72423735626e86bc",
"sha256": "b0db3b5b6a7322eed3170d6911a28344660e8740044fcfd1c129c0a107ac5856"
},
"downloads": -1,
"filename": "jammy-0.1.44-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09447e5c07867bbf72423735626e86bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8.1",
"size": 224438,
"upload_time": "2024-11-04T02:35:56",
"upload_time_iso_8601": "2024-11-04T02:35:56.228081Z",
"url": "https://files.pythonhosted.org/packages/01/c0/1b7b48bce79782cb5371c5c79666e8390783aebf6545171df3f38ceecc8e/jammy-0.1.44-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ecb4efee7d5172c9b8caa9f4e3ce11b19de75432fa721cb3a9613871d5870546",
"md5": "6403a40095e412fffa68abca0e2c7ea6",
"sha256": "985fb290e8008fd04c82107f9cbf37269b539d92dbf9a3d7a3838f3404c0d2c6"
},
"downloads": -1,
"filename": "jammy-0.1.44.tar.gz",
"has_sig": false,
"md5_digest": "6403a40095e412fffa68abca0e2c7ea6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8.1",
"size": 161527,
"upload_time": "2024-11-04T02:35:57",
"upload_time_iso_8601": "2024-11-04T02:35:57.946272Z",
"url": "https://files.pythonhosted.org/packages/ec/b4/efee7d5172c9b8caa9f4e3ce11b19de75432fa721cb3a9613871d5870546/jammy-0.1.44.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 02:35:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "jammy"
}
