Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 5.2 KB

README.md

File metadata and controls

77 lines (59 loc) · 5.2 KB
Raw

CircleCI pypi versions licence

distributions_gauss_bi

distributions_gauss_bi is a Python module/package for Machine Learning and Data Science built for Gaussian and Binomial distributions. This package is distributed under the MIT License.

Installation.

To install simply run(Commandline);

pip install distributions-gauss-bi

or

conda install distributions-gauss-bi

PyPI link: https://pypi.org/project/distributions-gauss-bi/

Testing.

For this test version of the package I would recommend running it on a Virtual Environment

pip install -i https://test.pypi.org/simple/ distributions-gauss-bi

TestPyPI link: https://test.pypi.org/project/distributions-gauss-bi/

Sample python test code.

On your commandline or favorite editor run below python code after installation.

>>> from distributions_gauss_bi import Gaussian, Binomial
>>> Gaussian(38,17)
>>> Binomial(0.4, 35)

Development.

  • I welcome new contributors of all experience levels. The goals of this package is to be helpful, welcoming, and effective.
  • You'll note that I'm using Unit Testing in each phase(1 to 4) of development to track bugs. To contribute follow programming code testing best practices.

Contibution.

There are many ways to contribute to distributions_gauss_bi, with the most common ones being contribution of code or documentation to the project. Improving the documentation is no less important than improving the module itself. If you find a typo in the documentation or have made improvements on pseudocode or source code, do not hesitate to submit a GitHub pull request.

  • NOTE Before reviewing the code I would encourage you go through the pseudocode

Important links.

Gaussian and Binomial distribution overview

1. Gaussian distribution (also known as Normal distribution)

  • In probability theory, a normal distribution is a type of continuous probability distribution for a real-valued random variable. The general form of its probability density function is The parameter is the mean or expectation of the distribution; and is its standard deviation. The general form of its probability density function is:

Further Resources.

If you would like to review the Gaussian (normal) distribution and binomial distribution, here are a few resources:

Dunder or magic methods in Python.

Dunder or magic methods in Python are the methods having two prefix and suffix underscores in the method name. Dunder here means “Double Under (Underscores)”. These are commonly used for operator overloading. eg __init__

For instance if you want to add two Gaussian distributions to create another object of a third Gaussian distribution;

  • This is what I mean: gauss_a + gauss_b = gauss_c

2. Binomial distribution.

  • In probability theory and statistics, the binomial distribution with parameters n and p is the discrete probability distribution of the number of successes in a sequence of n independent experiments, each asking a yes–no question, and each with its own boolean-valued outcome: success/yes/true/one (with probability p) or failure/no/false/zero (with probability q = 1 − p).