Metadata-Version: 2.1
Name: rsbox
Version: 0.0.9
Summary: A toolbox of utility functions I commonly use when programming in Python.
Project-URL: Homepage, https://github.com/rosikand/rsbox
Author-email: Rohan Sikand <rsikand29@gmail.com>
License: Copyright (c) 2018 The Python Packaging Authority
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# `rsbox`: Utility Toolbox

([Github](https://github.com/rosikand/rsbox) | [PyPI](https://pypi.org/project/rsbox) | [Documentation](https://rosikand.github.io/rsbox/))

A toolbox of utility functions [I](http://rosikand.github.io/) commonly use when programming in Python. Includes mostly machine learning utilities. 

The full API consists of importable functions from modules located in `src/rsbox/`. Functions are documented via docstrings under the function header. An HTML front-end documentation for the API is available [here](https://rosikand.github.io/rsbox/).

## Installation 

```
$ pip install rsbox
```

## Examples 

Here are some highlighted functions: 

```python
import rsbox
from rsbox import ml, misc

ml.print_model_size(pytorch_net)
current_time_in_string = misc.timestamp()
dataset = ml.image_dir_to_data(dirpath="./data", extension='png')
img_np_array = ml.get_img(url='https://stanford.edu/~rsikand/assets/images/seal.png')  
ml.plot(img_np_array)
```

<img width="200" alt="image" src="https://user-images.githubusercontent.com/57341225/190890819-6b4a5266-2f21-4703-a70e-e18358f5c247.png">





## Modules 

The modules are located in `src/rsbox/`

- `ml.py`: machine learning programming utilities. 
- `misc.py`: misc. utilities. 
