{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "#hide\n",
    "#default_cls_lvl 0\n",
    "from recohut.datasets import *\n",
    "from recohut.layers import *\n",
    "from recohut.metrics import *\n",
    "from recohut.models import *\n",
    "from recohut.utils import *\n",
    "from recohut.rl import *\n",
    "from recohut.visualization import *\n",
    "from recohut.transforms import *"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# recohut"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<div id=\"top\"></div>\n",
    "\n",
    "[![Contributors][contributors-shield]][contributors-url]\n",
    "[![Forks][forks-shield]][forks-url]\n",
    "[![Stargazers][stars-shield]][stars-url]\n",
    "[![Issues][issues-shield]][issues-url]\n",
    "[![MIT License][license-shield]][license-url]\n",
    "\n",
    "\n",
    "\n",
    "<!-- PROJECT LOGO -->\n",
    "<br />\n",
    "<div align=\"center\">\n",
    "  <a href=\"https://github.com/RecoHut-Projects/recohut\">\n",
    "    <img src=\"https://github.com/recohut/reco-static/raw/master/media/diagrams/recohut_logo.svg\" alt=\"Logo\" width=\"80\" height=\"80\">\n",
    "  </a>\n",
    "\n",
    "<!-- <h3 align=\"center\">recohut</h3> -->\n",
    "\n",
    "  <p align=\"center\">\n",
    "    a python library for building recommender systems.\n",
    "    <br />\n",
    "    <a href=\"https://recohut-projects.github.io/recohut\"><strong>Explore the docs »</strong></a>\n",
    "    <br />\n",
    "    <br />\n",
    "    <a href=\"https://github.com/RecoHut-Projects/recohut/tree/master/tutorials\">View Demo</a>\n",
    "    ·\n",
    "    <a href=\"https://github.com/RecoHut-Projects/recohut/issues\">Report Bug</a>\n",
    "    ·\n",
    "    <a href=\"https://github.com/RecoHut-Projects/recohut/issues\">Request Feature</a>\n",
    "  </p>\n",
    "</div>\n",
    "\n",
    "\n",
    "<!-- ABOUT THE PROJECT -->\n",
    "## About The Project\n",
    "\n",
    "<img src=\"https://github.com/recohut/reco-static/raw/master/media/diagrams/recohut_lib_main.svg\">\n",
    "\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "### Built With\n",
    "\n",
    "* [Python](https://www.python.org/)\n",
    "* [PyTorch](https://pytorch.org/)\n",
    "* [Numpy](https://numpy.org/)\n",
    "* [Pandas](https://pandas.pydata.org/)\n",
    "* [nbdev](https://github.com/fastai/nbdev)\n",
    "* [Jupyter](https://jupyter.org/)\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- GETTING STARTED -->\n",
    "## Getting Started\n",
    "\n",
    "To get a local copy up and running follow these simple example steps.\n",
    "\n",
    "### Prerequisites\n",
    "\n",
    "* pytorch\n",
    "  ```sh\n",
    "  pip install torch\n",
    "  ```\n",
    "\n",
    "### Installation\n",
    "\n",
    "```\n",
    "pip install recohut\n",
    "```\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- USAGE EXAMPLES -->\n",
    "## Usage\n",
    "\n",
    "```python\n",
    "# import the required modules\n",
    "import recohut\n",
    "from recohut.datasets import MovieLens\n",
    "from recohut.models import MatrixFactorization\n",
    "\n",
    "# define the data and model\n",
    "data = MovieLens(version='100k', download=True)\n",
    "model = MatrixFactorization()\n",
    "\n",
    "# train the matrix factorization model\n",
    "model.train(data)\n",
    "\n",
    "# evaluate the model\n",
    "model.evaluate(metrics=['MRR','HR'])\n",
    "```\n",
    "\n",
    "_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)._\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- ROADMAP -->\n",
    "## Roadmap\n",
    "\n",
    "- [] RecSys Model Deployment and MLOps features\n",
    "- [] RL agents and environment specific to recommender systems\n",
    "- [] Visualization utilities and EDA\n",
    "\n",
    "See the [open issues](https://github.com/RecoHut-Projects/recohut/issues) for a full list of proposed features (and known issues).\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- CONTRIBUTING -->\n",
    "## Contributing\n",
    "\n",
    "Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n",
    "\n",
    "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\".\n",
    "Don't forget to give the project a star! Thanks again!\n",
    "\n",
    "1. Fork the Project\n",
    "2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n",
    "3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n",
    "4. Push to the Branch (`git push origin feature/AmazingFeature`)\n",
    "5. Open a Pull Request\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- LICENSE -->\n",
    "## License\n",
    "\n",
    "Distributed under the MIT License. See `LICENSE.txt` for more information.\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- CONTACT -->\n",
    "## Contact\n",
    "\n",
    "Your Name - Sparsh A.\n",
    "\n",
    "Project Link: [https://github.com/RecoHut-Projects/recohut](https://github.com/RecoHut-Projects/recohut)\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- ACKNOWLEDGMENTS -->\n",
    "## Acknowledgments\n",
    "\n",
    "* [nbdev team](https://nbdev.fast.ai/tutorial.html) for providing supporting tools to build this library.\n",
    "* [colab team](https://colab.research.google.com/) for providing running VMs instances for development and testing.\n",
    "\n",
    "<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n",
    "\n",
    "\n",
    "\n",
    "<!-- MARKDOWN LINKS & IMAGES -->\n",
    "[contributors-shield]: https://img.shields.io/github/contributors/RecoHut-Projects/recohut.svg?style=for-the-badge\n",
    "[contributors-url]: https://github.com/RecoHut-Projects/recohut/graphs/contributors\n",
    "[forks-shield]: https://img.shields.io/github/forks/RecoHut-Projects/recohut.svg?style=for-the-badge\n",
    "[forks-url]: https://github.com/RecoHut-Projects/recohut/network/members\n",
    "[stars-shield]: https://img.shields.io/github/stars/RecoHut-Projects/recohut.svg?style=for-the-badge\n",
    "[stars-url]: https://github.com/RecoHut-Projects/recohut/stargazers\n",
    "[issues-shield]: https://img.shields.io/github/issues/RecoHut-Projects/recohut.svg?style=for-the-badge\n",
    "[issues-url]: https://github.com/RecoHut-Projects/recohut/issues\n",
    "[license-shield]: https://img.shields.io/github/license/RecoHut-Projects/recohut.svg?style=for-the-badge\n",
    "[license-url]: https://github.com/RecoHut-Projects/recohut/blob/master/LICENSE.txt\n",
    "[product-screenshot]: https://github.com/recohut/reco-static/raw/master/media/diagrams/recohut_lib_main.svg"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}
