Metadata-Version: 2.4
Name: infoweight
Version: 0.0.3
Summary: An information theoretic generalization of TF-IDF.
Keywords: tfidf,information theory,metric learning,unsupervised learning
License-Expression: BSD-3-Clause
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Requires-Dist: numpy>=2.0.0
Requires-Dist: numba>=0.51
Requires-Dist: scikit-learn>=0.22
Requires-Dist: scipy>=1.8
Maintainer: Ryan DeWolfe
Maintainer-email: Ryan DeWolfe <ryan.dewolfe@uwaterloo.ca>
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/ryandewolfe33/infoweight
Project-URL: Repository, https://github.com/ryandewolfe33/infoweight
Description-Content-Type: text/x-rst

===========
Infoweight
===========

.. |docs| image:: https://readthedocs.org/projects/infoweight/badge/?version=latest
    :target: https://infoweight.readthedocs.io/en/latest/index.html
    :alt: Documentation Status

.. |build| image:: https://github.com/ryandewolfe33/infoweight/actions/workflows/ci.yaml/badge.svg
    :target: https://github.com/ryandewolfe33/infoweight/actions/workflows/ci.yaml
    :alt: Build Status

|docs| |build|


This package provides the `InformationWeightTransformer`, an information theoretic generalization
of the `TFIDFTransformer`.


The `InformationWeightTransformer` was originally part of the
`vectorizers <https://github.com/TutteInstitute/vectorizers>`_
package, but has been factored out to ease development. You can find alternate and helpful
documentation, although likely out of data, at
`vectorizers documentation <https://vectorizers.readthedocs.io/en/latest/>`_.


----------
Installing
----------

To install the package from PyPI:

.. code:: bash

    pip install infoweight

Or to clone and install locally:

.. code:: bash

    git clone https://github.com/ryandewolfe33/infoweight.git &&
    cd infoweight &&
    pip install .

To install the package from source:

.. code:: bash

    pip install https://github.com/ryandewolfe33/infoweight/archive/master.zip

------------
Contributing
------------

Contributions are more than welcome! There are lots of opportunities
for potential projects, so please get in touch if you would like to
help out. Everything from code to notebooks to examples and documentation
are all *equally valuable* so please don't feel you can't contribute.


To contribute please `fork the project <https://github.com/ryandewolfe33/infoweight/fork>`_
make your changes and submit a pull request. We will do our best to work
through any issues with you and get your code merged into the main branch.

-------
License
-------

The infoweight package is 3-clause BSD licensed.
