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

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

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


This package is still under development,
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 an
overview and example of using the package in the
`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.
