GithubHelp home page GithubHelp logo

puffy's Introduction

PUffy

Put a label on it

Welcome to PUffy! ๐Ÿก

PUffy is a Python library designed for creating the best possible models given a dataset with positive-unlabeled data. It implements two-step classification approach. The package is also suitable for considerations on PU classification with fully labeled dataset, as the package presents labeling methods to artificially mimic labeling mechanisms resulting in positive-unlabeled data. Puffy consists of four modules, namely labelling_methods, rn_methods, training and pu_pipeline.

So far, it offers:

๐Ÿก 4 labeling methods:

  • one method assuming SCAR scenario,

  • three methods being variants of SAR setting,

๐Ÿก 3 techniques for identifying reliable-negatives sample from the unlabeled data:

  • a technique based on KMeans,

  • a technique based on KNN,

  • a technique based on Spy analysis,

  • an iterative classification model for identifying reliable negatives, using Logistic Regression classification,

๐Ÿก visualizations of the model performance,

๐Ÿก a naive classification method for comparison,

๐Ÿก a pipeline, with which presented experiments were conducted.

As of today, the package is meant for binary classification problems.

Documentation

Full documentation is available here: I'm here!

Installation

Thank you for choosing Puffy! This section provides instructions on how to install and set up PUffy on your system.

Prerequisites

Before you begin, ensure you have the following prerequisites:

๐Ÿก Python 3.6 or later installed on your system. You can download Python from https://www.python.org/downloads/. ๐Ÿก Ensure pip (Python package installer) is available. If it's not installed, you can follow the instructions at https://pip.pypa.io/en/stable/installation/.

Step by step

Step 1: Locate the Package

Visit the GitHub repository to find the latest release of Puffy: https://github.com/kopyta/PUffy

Step 2: Choose a Release

Navigate to the "Releases" section and choose the version you want to install. You can find the releases at: https://github.com/kopyta/PUffy/releases

Step 3: Download the Package

Download the appropriate package for your platform:

Option 1: Wheel file (.whl)

Run the following commands:

wget https://github.com/kopyta/PUffy/releases/v1.0/puffy-1.0-py3-none-any.whl
pip install puffy-1.0-py3-none-any.whl

or

Option 2: Tarball file (.tar.gz)

Run the following commands:

wget https://github.com/kopyta/PUffy/releases/v1.0/puffy-1.0.tar.gz
pip install puffy-1.0.tar.gz

Step 4: Congratulations! ๐Ÿก

You've successfully installed Puffy! Get ready to embark on the exciting challenges of PU data classification. Enjoy exploring the capabilities of Puffy and make the most out of its features! For more information visit our documentation: ๐ŸกCLick๐Ÿก

Happy coding! ๐Ÿš€

The package is a result of the bachelor's thesis, origining from this repository

puffy's People

Contributors

kopyta avatar

Watchers

 avatar

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.