Metadata-Version: 2.1
Name: recohut
Version: 0.0.8
Summary: A python library for building recommender systems.
Home-page: https://github.com/RecoHut-Projects/recohut/tree/master/
Author: recohut
Author-email: recohut@gmail.com
License: Apache Software License 2.0
Keywords: recsys,python,deeplearning,machinelearning
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# recohut



<div id="top"></div>

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]



<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/RecoHut-Projects/recohut">
    <img src="https://raw.githubusercontent.com/RecoHut-Projects/recohut/master/https://github.com/recohut/reco-static/raw/master/media/diagrams/recohut_logo.svg" alt="Logo" width="80" height="80">
  </a>

<!-- <h3 align="center">recohut</h3> -->

  <p align="center">
    a python library for building recommender systems.
    <br />
    <a href="https://recohut-projects.github.io/recohut"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/RecoHut-Projects/recohut/tree/master/tutorials">View Demo</a>
    ·
    <a href="https://github.com/RecoHut-Projects/recohut/issues">Report Bug</a>
    ·
    <a href="https://github.com/RecoHut-Projects/recohut/issues">Request Feature</a>
  </p>
</div>


<!-- ABOUT THE PROJECT -->
## About The Project

[![Product Name Screen Shot][product-screenshot]](https://github.com/RecoHut-Projects/recohut)


<p align="right">(<a href="#top">back to top</a>)</p>



### Built With

* [Python](https://www.python.org/)
* [PyTorch](https://pytorch.org/)
* [Numpy](https://numpy.org/)
* [Pandas](https://pandas.pydata.org/)
* [nbdev](https://github.com/fastai/nbdev)
* [Jupyter](https://jupyter.org/)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started

To get a local copy up and running follow these simple example steps.

### Prerequisites

* pytorch
  ```sh
  pip install torch
  ```

### Installation

```
pip install recohut
```

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- USAGE EXAMPLES -->
## Usage

```python
# import the required modules
import recohut
from recohut.datasets import MovieLens
from recohut.models import MatrixFactorization

# define the data and model
data = MovieLens(version='100k', download=True)
model = MatrixFactorization()

# train the matrix factorization model
model.train(data)

# evaluate the model
model.evaluate(metrics=['MRR','HR'])
```

_For more examples, please refer to the [Documentation](https://recohut-projects.github.io/recohut) and [Tutorials](https://github.com/RecoHut-Projects/recohut/tree/master/tutorials)._

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- ROADMAP -->
## Roadmap

- [] RecSys Model Deployment and MLOps features
- [] RL agents and environment specific to recommender systems
- [] Visualization utilities and EDA

See the [open issues](https://github.com/RecoHut-Projects/recohut/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE.txt` for more information.

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- CONTACT -->
## Contact

Your Name - Sparsh A.

Project Link: [https://github.com/RecoHut-Projects/recohut](https://github.com/RecoHut-Projects/recohut)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- ACKNOWLEDGMENTS -->
## Acknowledgments

* [nbdev team](https://nbdev.fast.ai/tutorial.html) for providing supporting tools to build this library.
* [colab team](https://colab.research.google.com/) for providing running VMs instances for development and testing.

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- MARKDOWN LINKS & IMAGES -->
[contributors-shield]: https://img.shields.io/github/contributors/RecoHut-Projects/recohut.svg?style=for-the-badge
[contributors-url]: https://github.com/RecoHut-Projects/recohut/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/RecoHut-Projects/recohut.svg?style=for-the-badge
[forks-url]: https://github.com/RecoHut-Projects/recohut/network/members
[stars-shield]: https://img.shields.io/github/stars/RecoHut-Projects/recohut.svg?style=for-the-badge
[stars-url]: https://github.com/RecoHut-Projects/recohut/stargazers
[issues-shield]: https://img.shields.io/github/issues/RecoHut-Projects/recohut.svg?style=for-the-badge
[issues-url]: https://github.com/RecoHut-Projects/recohut/issues
[license-shield]: https://img.shields.io/github/license/RecoHut-Projects/recohut.svg?style=for-the-badge
[license-url]: https://github.com/RecoHut-Projects/recohut/blob/master/LICENSE.txt
[product-screenshot]: https://github.com/recohut/reco-static/raw/master/media/diagrams/recohut_lib_main.svg


