# UsfUtils
English</a> | <a href="README_CN.md">简体中文</a>
[](https://pypi.org/project/usfutils/) [](LICENSE)
This is an open-source universal toolkit named **Useful Utilities** for **Deep Learning**, **Machine Learning**, and
other Python projects.
## 🚩Features
- Aiming to provide frequently-used functions mainly about **log management**, **configuration management**, and **file/directory management**.
- To help researchers and engineers avoid wasteful duplication of effort.
- Rely solely on native Python / Pytorch and does not depend on any other third-party package.
## 🚀What's New?
- 2023.11.29 Add object-load module; Release version 2.0.0
- 2023.11.28 Add data type UsfDict and integrate it with UsfConfig; Release version 1.0.0
- 2023.11.27 Add statistical modules, such as statistical model parameters
- 2023.11.17 Add basic log management functions: initialize logger and manage multi-process logs
- 2023.11.16 Add basic directory management functions: create, rename, and scan
- 2023.11.16 Initialization
## 💻How to Install?
Environmental requirements: Python 3.x
It is suggested to install it via the following command:
```shell
pip install usfutils
```
Or installing through source code:
```shell
git clone https://github.com/chenaoxuan/UsfUtils.git
cd UsfUtils
pip install .
```
## Reference
Some modules of this project refer to the following repos:
[BasicSR](https://github.com/XPixelGroup/BasicSR.git)
[omegaconf](https://github.com/omry/omegaconf.git)
[Pytorch Lightning](https://github.com/Lightning-AI/lightning.git)
[easydict](https://github.com/makinacorpus/easydict.git)
Raw data
{
"_id": null,
"home_page": "https://github.com/chenaoxuan/UsfUtils.git",
"name": "usfutils",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,pytorch,utils",
"author": "AoXuan Chen",
"author_email": "cax1165@163.com",
"download_url": "https://files.pythonhosted.org/packages/d6/4e/02784380d83409a60cf24d718b9ace68287e0530e132386de01bd286f138/usfutils-2.0.3.tar.gz",
"platform": null,
"description": "# UsfUtils\r\n\r\nEnglish</a> | <a href=\"README_CN.md\">\u7b80\u4f53\u4e2d\u6587</a>\r\n\r\n[](https://pypi.org/project/usfutils/) [](LICENSE)\r\n\r\nThis is an open-source universal toolkit named **Useful Utilities** for **Deep Learning**, **Machine Learning**, and\r\nother Python projects.\r\n\r\n## \ud83d\udea9Features\r\n\r\n- Aiming to provide frequently-used functions mainly about **log management**, **configuration management**, and **file/directory management**.\r\n- To help researchers and engineers avoid wasteful duplication of effort.\r\n- Rely solely on native Python / Pytorch and does not depend on any other third-party package.\r\n\r\n## \ud83d\ude80What's New?\r\n\r\n- 2023.11.29 Add object-load module; Release version 2.0.0\r\n- 2023.11.28 Add data type UsfDict and integrate it with UsfConfig; Release version 1.0.0\r\n- 2023.11.27 Add statistical modules, such as statistical model parameters\r\n- 2023.11.17 Add basic log management functions: initialize logger and manage multi-process logs\r\n- 2023.11.16 Add basic directory management functions: create, rename, and scan\r\n- 2023.11.16 Initialization\r\n\r\n## \ud83d\udcbbHow to Install?\r\n\r\nEnvironmental requirements: Python 3.x\r\n\r\nIt is suggested to install it via the following command:\r\n\r\n```shell\r\npip install usfutils\r\n```\r\n\r\nOr installing through source code:\r\n\r\n```shell\r\ngit clone https://github.com/chenaoxuan/UsfUtils.git\r\ncd UsfUtils\r\npip install .\r\n```\r\n\r\n## Reference\r\n\r\nSome modules of this project refer to the following repos:\r\n\r\n[BasicSR](https://github.com/XPixelGroup/BasicSR.git)\r\n\r\n[omegaconf](https://github.com/omry/omegaconf.git)\r\n\r\n[Pytorch Lightning](https://github.com/Lightning-AI/lightning.git)\r\n\r\n[easydict](https://github.com/makinacorpus/easydict.git)\r\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Open Source Universal Tool Library for Python Project",
"version": "2.0.3",
"project_urls": {
"Homepage": "https://github.com/chenaoxuan/UsfUtils.git"
},
"split_keywords": [
"python",
"pytorch",
"utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "885a5df2c18997a1e8c8b413777ee934284e2cb25900b4682598432cf0124a13",
"md5": "486b1dda060e9fa89adb9cbfcd4019e1",
"sha256": "cba7104f1340276c370b3c384b0bc12a2ecce844a7db5ae72aa708074885c962"
},
"downloads": -1,
"filename": "usfutils-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "486b1dda060e9fa89adb9cbfcd4019e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15279,
"upload_time": "2023-12-02T15:14:51",
"upload_time_iso_8601": "2023-12-02T15:14:51.775325Z",
"url": "https://files.pythonhosted.org/packages/88/5a/5df2c18997a1e8c8b413777ee934284e2cb25900b4682598432cf0124a13/usfutils-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d64e02784380d83409a60cf24d718b9ace68287e0530e132386de01bd286f138",
"md5": "54afd8bc3ca73562b8a4c8f145f419ca",
"sha256": "0d542b3aa4fa21217ac6a40b8099c3a5b9ff0a9fc34a3b0d3b22408a6995e0e8"
},
"downloads": -1,
"filename": "usfutils-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "54afd8bc3ca73562b8a4c8f145f419ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13304,
"upload_time": "2023-12-02T15:14:53",
"upload_time_iso_8601": "2023-12-02T15:14:53.600668Z",
"url": "https://files.pythonhosted.org/packages/d6/4e/02784380d83409a60cf24d718b9ace68287e0530e132386de01bd286f138/usfutils-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-02 15:14:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chenaoxuan",
"github_project": "UsfUtils",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "usfutils"
}
JSON
