jammy


Namejammy JSON
Version 0.1.37 PyPI version JSON
download
home_pageNone
SummaryA Versatile ToolBox
upload_time2024-03-23 07:01:40
maintainerNone
docs_urlNone
authorQin
requires_python<3.12,>=3.8.1
licenseMIT
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/f2/cb/bcabcf14e76499d1815ae32ed0da213602465a4bebc1a0de05199c7b0d83/jammy-0.1.37.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.37",
    "project_urls": {
        "Documentation": "https://jammy.readthedocs.io/en/latest/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6f4cdadeda30e8ec0eaa676dd10661bc19a8334ac30d26989612f84aede5ee08",
                "md5": "38d3ea350c0cc2636eef666ea8e58543",
                "sha256": "382d6a8a5acdc7860a810940e191eb7379fe279e17e99a0049c6d6d329584dd4"
            },
            "downloads": -1,
            "filename": "jammy-0.1.37-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "38d3ea350c0cc2636eef666ea8e58543",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.8.1",
            "size": 197896,
            "upload_time": "2024-03-23T07:01:33",
            "upload_time_iso_8601": "2024-03-23T07:01:33.648072Z",
            "url": "https://files.pythonhosted.org/packages/6f/4c/dadeda30e8ec0eaa676dd10661bc19a8334ac30d26989612f84aede5ee08/jammy-0.1.37-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f2cbbcabcf14e76499d1815ae32ed0da213602465a4bebc1a0de05199c7b0d83",
                "md5": "becad8d9358043f0be51d87e3d162e72",
                "sha256": "b88c99fae694e1c44dd42f2d7ffbbfabf621e42e110ff1619795e74be5cb0118"
            },
            "downloads": -1,
            "filename": "jammy-0.1.37.tar.gz",
            "has_sig": false,
            "md5_digest": "becad8d9358043f0be51d87e3d162e72",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.8.1",
            "size": 139573,
            "upload_time": "2024-03-23T07:01:40",
            "upload_time_iso_8601": "2024-03-23T07:01:40.480083Z",
            "url": "https://files.pythonhosted.org/packages/f2/cb/bcabcf14e76499d1815ae32ed0da213602465a4bebc1a0de05199c7b0d83/jammy-0.1.37.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-23 07:01:40",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "jammy"
}
        
Qin
Elapsed time: 0.52437s