Coder Social home page Coder Social logo

wiseaidev / pydist2 Goto Github PK

View Code? Open in Web Editor NEW
20.0 2.0 5.0 84 KB

A python library for computing distances.

Home Page: https://pydist2.readthedocs.io

License: MIT License

Makefile 3.24% Python 96.76%
distance distance-calculation distance-matrix euclidean-distances python3 hacktoberfest

pydist2's Introduction

pydist2

Documentation Status

pydist2 is a python library that provides a set of methods for calculating distances between observations. There are two main classes:

  • pdist1 which calculates the pairwise distances between observations in one matrix and returns a distance matrix.
  • pdist2 computes the distances between observations in two matrices and also returns a distance matrix.

Usage

pdist1(P, metric = "euclidean", matrix=False)
pdist2(P, Q, metric = "minkowski", exp = 3)

Arguments:

  • two matrices P and Q.
  • metric: The distance function to use.
  • exp: The exponent of the Minkowski distance.

Installation

The pydist2 library is available on Pypi. Thus, you can install the latest available version using pip:

pip install pydist2

Supported Python versions

pydist2 has been tested with Python 3.7 and 3.8.

For more information, please checkout the documentation which is available at readthedocs.

This program and the accompanying materials are made available under the terms of the MIT License.

Progress & Features

  • ☑ Commit the first code's version.

  • ☑ Support the following list of distances.

  • ☑ Display the distance in a matrix form(a combination for each pair of points):

    >>> X = np.array([[100, 100],[0, 100],[100, 0], [500, 400], [300, 600]])
    >>> pdist1(X,matrix=True) # by default, metric = 'euclidean'
    array([[100.    , 100.    , 100.    ,   0.    , 100.    ],
           [100.    , 100.    , 100.    , 100.    ,   0.    ],
           [500.    , 100.    , 100.    , 500.    , 400.    ],
           [538.5165, 100.    , 100.    , 300.    , 600.    ],
           [141.4214,   0.    , 100.    , 100.    ,   0.    ],
           [583.0952,   0.    , 100.    , 500.    , 400.    ],
           [583.0952,   0.    , 100.    , 300.    , 600.    ],
           [565.6854, 100.    ,   0.    , 500.    , 400.    ],
           [632.4555, 100.    ,   0.    , 300.    , 600.    ],
           [282.8427, 500.    , 400.    , 300.    , 600.    ]])
    

where the first column represents the distance between each pair of observations. for instance, the euclidean distance between (100. , 100.) and ( 0. , 100.) is 100.

  • ☑ Support numpy arrays of the same size only.

Todo list

  • ☐ Re-validate the correctness of the distances equations.
  • ☐ Performance tests & vectorization.
  • ☐ Adding new distances.
  • ☐ Adding a squared form of the distance.
  • ☐ Support tuples and list.
  • ☐ Remove numpy from dependencies.
  • ☐ Write more test cases.
  • ☐ Handling Exceptions.
  • ☐ Restructure the docs.

pydist2's People

Contributors

wiseaidev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

pydist2's Issues

Move from `setup.cfg`, `setup.py`, `MANIFEST.in`, and `requirements.txt` to `pyproject.toml`.

Is your feature request related to a specific problem?

The use of setup.cfg, setup.py, MANIFEST.in, and requirements.txt files is quite outdated. Because of PEP 517, PEP 660, and PEP 631, the packaging is now being standardized on the usage of the pyproject.toml file.

Describe the solution you'd like

Given the above info, I am going to update the project packaging to support pyproject.toml.

Describe alternatives you've considered if any

Not available.

Additional context

That's pretty much it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.