PatentsView-Evaluation's documentation
======================================

.. currentmodule:: pv_evaluation

PatentsView-Evaluation is a Python package for the evaluation and benchmarking of PatentsView disambiguation algorithms.

To get started, please refer to the :doc:`README <readme>`, the :doc:`examples <examples>` page, or the :doc:`API documentation <pv_evaluation>`.
Use the project's `Discussion <https://github.com/PatentsView/PatentsView-Evaluation/discussions>`_ page to ask questions and the `Issues <https://github.com/PatentsView/PatentsView-Evaluation/issues>`_ page to request features and report bugs.

.. grid:: 2

    .. grid-item-card::  🚀 README
      :text-align: center
      :link: readme
      :link-type: doc
      
      Get started with an overview of the package, installation instructions, and more.

    .. grid-item-card::  🤔 Key Concepts
      :text-align: center
      :link: concepts
      :link-type: doc

      Review key concepts used throughout the package.

.. grid:: 2

    .. grid-item-card:: 🧑‍💻 Examples
      :text-align: center
      :link: examples
      :link-type: doc

      Follow through reproducible examples of the package's functionality.

    .. grid-item-card:: 🗃️ API Doc
      :text-align: center
      :link: pv_evaluation
      :link-type: doc

      Access detailed documentation for all modules and functions.


.. toctree::
   :maxdepth: 2
   :hidden:

   readme
   concepts
   examples
   pv_evaluation