Metadata-Version: 2.1
Name: ltr
Version: 0.0.1
Summary: A fast Learning to Rank library based on RankLib
Home-page: https://marcosfpr.github.io
Author: MatchUp
Author-email: mfprezende@gmail.com
License: MIT
Project-URL: Release notes, https://github.com/matchup-ir/ranky/releases
Project-URL: Source, https://github.com/matchup-ir/ranky
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools
Requires-Dist: packaging (>=20.0)
Requires-Dist: typing-extensions (<4.0.0.0,>=3.7.4) ; python_version < "3.8"

[![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]
[![codecov][codecov-shield]][codecov-url]
[![LinkedIn][linkedin-shield]][linkedin-url]



<!-- PROJECT LOGO -->
<br />
<p align="center">

[comment]: <> (  <a href="https://github.com/matchup-ir/ranky">)

[comment]: <> (    <img src="images/logo.png" alt="Logo" width="300" height="150">)

[comment]: <> (  </a>)

  <h3 align="center">Learning to Rank ++</h3>

  <p align="center">
    A fast Learning to Rank library based on RankLib
    <br />
    <a href="https://ltr.readthedocs.io/"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/matchup-ir/ranky/issues">Report Bug</a>
    ·
    <a href="https://github.com/matchup-ir/ranky/issues">Request Feature</a>
  </p>
</p>



<!-- TABLE OF CONTENTS -->
<details open="open">
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built With</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#integration">Integration</a></li>
      </ul>
    </li>
    <li><a href="#usage">Usage</a></li>
    <li><a href="#roadmap">Roadmap</a></li>
    <li><a href="#contributing">Contributing</a></li>
    <li><a href="#license">License</a></li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>



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

rankY is a Learning to Rank library written in Cython and based on the famous [RankLib](https://sourceforge.net/p/lemur/wiki/RankLib%20How%20to%20use/) library. The main goal of this project is to provide a simple, fast and memory safe wich implements a wide variety of LTR models. 

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

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


<!-- ROADMAP -->
## Roadmap

The project is in the early stages of development. Thus, feel free to contribute and help ltr++ to grow up!

See the [open issues](https://github.com/matchup-ir/ranky/issues) for a list of proposed features (and known issues).

**OBS**: To propose new features or report bugs, check out the correct templates.

<!-- CONTRIBUTING -->
## Contributing

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

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

<!-- LICENSE -->
## License

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

<!-- CONTACT -->
## Contact

Marcos Pontes - mfprezende@gmail.com

Project Link: [https://github.com/matchup-ir/ranky](https://github.com/matchup-ir/ranky)


<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/matchup-ir/ranky.svg?style=for-the-badge
[contributors-url]: https://github.com/matchup-ir/ranky/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/matchup-ir/ranky.svg?style=for-the-badge
[forks-url]: https://github.com/matchup-ir/ranky/network/members
[stars-shield]: https://img.shields.io/github/stars/matchup-ir/ranky.svg?style=for-the-badge
[stars-url]: https://github.com/matchup-ir/ranky/stargazers
[issues-shield]: https://img.shields.io/github/issues/matchup-ir/ranky.svg?style=for-the-badge
[issues-url]: https://github.com/matchup-ir/ranky/issues
[license-shield]: https://img.shields.io/github/license/matchup-ir/ranky.svg?style=for-the-badge
[license-url]: https://github.com/matchup-ir/ranky/blob/master/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/marcosfpr
[product-screenshot]: images/logo.png
[codecov-shield]: https://img.shields.io/codecov/c/github/matchup-ir/ranky?style=for-the-badge
[codecov-url]: https://codecov.io/gh/marcosfpr/ltrp

