| Name | rics JSON |
| Version |
5.0.1
JSON |
| download |
| home_page | None |
| Summary | My personal little ML engineering library. |
| upload_time | 2025-02-01 15:41:41 |
| maintainer | None |
| docs_url | None |
| author | Richard Sundqvist |
| requires_python | >=3.11 |
| license | None |
| keywords |
rics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
<div align="center">
<img src="https://github.com/rsundqvist/rics/raw/master/docs/logo-text.png"><br>
</div>
-----------------
# RiCS: my personal little ML engineering library. <!-- omit in toc -->
[](https://pypi.python.org/pypi/rics)
[](https://pypi.python.org/pypi/rics)
[](https://github.com/rsundqvist/rics/actions?workflow=tests)
[](https://codecov.io/gh/rsundqvist/rics)
[](https://rics.readthedocs.io/)
[](https://pypi.python.org/pypi/rics)
## What is it?
An assorted collection of reusable functions that used to live in a Dropbox folder. RiCS, pronounced _"rix_", is short
for _**Ri**chard's **C**ode **S**tash_. I started this project with the purpose of learning more about Python best
practices, typing and the Python ecosystem.
It has grown organically since then, and now provides a wide variety of small utility functions. Large submodules are
typically converted to [stand-alone PyPI packages](#related-libraries) once they begin to mature.
## Highlighted Features
- Multivariate [performance testing][perf] and [plotting][perf-plot].
- [get_by_full_name()]: Import functions, objects and classes by name.
- [rics.collections.dicts]: Extended functionality for the built-in `dict` type.
- [basic_config()]: Configure logging for development.
- And much more; click [here](https://rics.readthedocs.io/en/stable/_autosummary/rics.html) for the full API.
## Related libraries
The following packages started life as RiCS submodules.
* ID Translation
[](https://pypi.python.org/pypi/id-translation)
[](https://id-translation.readthedocs.io/)
**_Turn meaningless IDs into human-readable labels._**
* Time Split
[](https://pypi.python.org/pypi/time-split)
[](https://time-split.readthedocs.io/)
**_Time-based k-fold validation splits for heterogeneous data._**
[perf]: https://rics.readthedocs.io/en/stable/_autosummary/rics.performance.html#rics.performance.run_multivariate_test
[perf-plot]: https://rics.readthedocs.io/en/stable/_autosummary/rics.performance.html#rics.performance.plot_run
[get_by_full_name()]: https://rics.readthedocs.io/en/stable/_autosummary/rics.misc.html#rics.misc.get_by_full_name
[basic_config()]: https://rics.readthedocs.io/en/stable/_autosummary/rics.logs.html#rics.logs.basic_config
[rics.collections.dicts]: https://rics.readthedocs.io/en/stable/_autosummary/rics.collections.dicts.html
## Installation
The package is published through the [Python Package Index (PyPI)]. Source code
is available on GitHub: https://github.com/rsundqvist/rics
```sh
pip install -U rics
```
This is the preferred method to install ``rics``, as it will always install the
most recent stable release.
If you don't have [pip] installed, this [Python installation guide] can guide
you through the process.
## License
[MIT](LICENSE.md)
## Documentation
Hosted on Read the Docs: https://rics.readthedocs.io
## Contributing
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. To get
started, see the [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).
[Python Package Index (PyPI)]: https://pypi.org/project/rics
[pip]: https://pip.pypa.io
[Python installation guide]: http://docs.python-guide.org/en/stable/starting/installation/
Raw data
{
"_id": null,
"home_page": null,
"name": "rics",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "rics",
"author": "Richard Sundqvist",
"author_email": "richard.sundqvist@live.se",
"download_url": "https://files.pythonhosted.org/packages/29/b9/23879f37d431bbba68d61e5257bad2c6fe426d2ab2ef4ace330547e7bcc0/rics-5.0.1.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://github.com/rsundqvist/rics/raw/master/docs/logo-text.png\"><br>\n</div>\n\n-----------------\n\n# RiCS: my personal little ML engineering library. <!-- omit in toc -->\n[](https://pypi.python.org/pypi/rics)\n[](https://pypi.python.org/pypi/rics)\n[](https://github.com/rsundqvist/rics/actions?workflow=tests)\n[](https://codecov.io/gh/rsundqvist/rics)\n[](https://rics.readthedocs.io/)\n[](https://pypi.python.org/pypi/rics)\n\n## What is it?\nAn assorted collection of reusable functions that used to live in a Dropbox folder. RiCS, pronounced _\"rix_\", is short \nfor _**Ri**chard's **C**ode **S**tash_. I started this project with the purpose of learning more about Python best \npractices, typing and the Python ecosystem.\n\nIt has grown organically since then, and now provides a wide variety of small utility functions. Large submodules are\ntypically converted to [stand-alone PyPI packages](#related-libraries) once they begin to mature.\n\n## Highlighted Features\n- Multivariate [performance testing][perf] and [plotting][perf-plot].\n- [get_by_full_name()]: Import functions, objects and classes by name.\n- [rics.collections.dicts]: Extended functionality for the built-in `dict` type.\n- [basic_config()]: Configure logging for development.\n- And much more; click [here](https://rics.readthedocs.io/en/stable/_autosummary/rics.html) for the full API.\n\n## Related libraries\nThe following packages started life as RiCS submodules.\n\n* ID Translation\n [](https://pypi.python.org/pypi/id-translation) \n [](https://id-translation.readthedocs.io/)\n\n **_Turn meaningless IDs into human-readable labels._**\n\n* Time Split\n [](https://pypi.python.org/pypi/time-split)\n [](https://time-split.readthedocs.io/)\n\n **_Time-based k-fold validation splits for heterogeneous data._**\n\n[perf]: https://rics.readthedocs.io/en/stable/_autosummary/rics.performance.html#rics.performance.run_multivariate_test\n[perf-plot]: https://rics.readthedocs.io/en/stable/_autosummary/rics.performance.html#rics.performance.plot_run\n\n[get_by_full_name()]: https://rics.readthedocs.io/en/stable/_autosummary/rics.misc.html#rics.misc.get_by_full_name\n\n[basic_config()]: https://rics.readthedocs.io/en/stable/_autosummary/rics.logs.html#rics.logs.basic_config\n[rics.collections.dicts]: https://rics.readthedocs.io/en/stable/_autosummary/rics.collections.dicts.html\n\n## Installation\nThe package is published through the [Python Package Index (PyPI)]. Source code\nis available on GitHub: https://github.com/rsundqvist/rics\n\n```sh\npip install -U rics\n```\n\nThis is the preferred method to install ``rics``, as it will always install the\nmost recent stable release.\n\nIf you don't have [pip] installed, this [Python installation guide] can guide\nyou through the process.\n\n## License\n[MIT](LICENSE.md)\n\n## Documentation\nHosted on Read the Docs: https://rics.readthedocs.io\n\n## Contributing\n\nAll contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. To get \nstarted, see the [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md).\n\n[Python Package Index (PyPI)]: https://pypi.org/project/rics\n[pip]: https://pip.pypa.io\n[Python installation guide]: http://docs.python-guide.org/en/stable/starting/installation/\n\n",
"bugtrack_url": null,
"license": null,
"summary": "My personal little ML engineering library.",
"version": "5.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/rsundqvist/rics/issues",
"Changelog": "https://github.com/rsundqvist/rics/blob/master/CHANGELOG.md",
"Documentation": "https://rics.readthedocs.io",
"Homepage": "https://github.com/rsundqvist/rics",
"Repository": "https://github.com/rsundqvist/rics"
},
"split_keywords": [
"rics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "694108777fc5190b1b10477851ca351fb9e59967c8959418271afaa085443634",
"md5": "58db870d37f9be4203b46d8967eca8c0",
"sha256": "d638d38e18a42e67dad34054724a008b7d59543f33bfda203f080e230668fe1d"
},
"downloads": -1,
"filename": "rics-5.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "58db870d37f9be4203b46d8967eca8c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 51048,
"upload_time": "2025-02-01T15:41:39",
"upload_time_iso_8601": "2025-02-01T15:41:39.768399Z",
"url": "https://files.pythonhosted.org/packages/69/41/08777fc5190b1b10477851ca351fb9e59967c8959418271afaa085443634/rics-5.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29b923879f37d431bbba68d61e5257bad2c6fe426d2ab2ef4ace330547e7bcc0",
"md5": "90b0bdde3e598a64ca0d6b82d92db924",
"sha256": "86134344ba8c7455d91c8c5c78b2ab57150868d0fbe2a084f51edd8297234bad"
},
"downloads": -1,
"filename": "rics-5.0.1.tar.gz",
"has_sig": false,
"md5_digest": "90b0bdde3e598a64ca0d6b82d92db924",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 40386,
"upload_time": "2025-02-01T15:41:41",
"upload_time_iso_8601": "2025-02-01T15:41:41.520205Z",
"url": "https://files.pythonhosted.org/packages/29/b9/23879f37d431bbba68d61e5257bad2c6fe426d2ab2ef4ace330547e7bcc0/rics-5.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-01 15:41:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rsundqvist",
"github_project": "rics",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "rics"
}
