Skip to main content

Learning-first machine learning utilities library for simplified imports, sampling, splitting, and probabilistic preprocessing.

Project description

QuickLearnKit

QuickLearnKit is a learning-first machine learning utilities library designed to make common ML and data science workflows simple, readable, and beginner-friendly — without blocking advanced users from full customization.

The philosophy is:

Remove mechanical friction so students can focus on concepts, not syntax.

QuickLearnKit provides:

  • Easy model imports
  • Random sampling utilities
  • Train–test splitting
  • Probabilistic, group-aware imputation
  • Teaching-friendly plotting with optional value labels

Installation

pip install quicklearnkit

Quick Start

from quicklearnkit import (
    Sampler,
    train_test_split,
    ProbabilisticImputer,
    bar_plot
)

import seaborn as sns

# Load example dataset
df = sns.load_dataset("titanic")

# Sample data
sampler = Sampler(df, n=5, random_state=42)
print(sampler.sample())

# Split data
train, test = train_test_split(df, test_size=0.25)

# Impute missing values
imputer = ProbabilisticImputer("pclass", "deck", random_state=42)
df_imputed = imputer.fit_transform(df)

# Plot
bar_plot(df, x="class", y="fare", show_values="yes")

Model Imports

QuickLearnKit allows you to import commonly used machine learning models without navigating deep module paths.

Example

from quicklearnkit import (
    LinearRegressionmodel,
    RandomForestRegressionmodel,
    XGBoostRegressionmodel,
    KNeighborsClassifiermodel,
    GradientBoostingClassifiermodel
)

lr_model = LinearRegressionmodel()
rf_model = RandomForestRegressionmodel()
xgb_model = XGBoostRegressionmodel()

knn_classifier = KNeighborsClassifiermodel()
gb_classifier = GradientBoostingClassifiermodel()

Supported Models

Regression Models

  • LinearRegressionmodel()
  • KNNRegressionmodel()
  • DecisionTreeRegressionmodel()
  • RandomForestRegressionmodel()
  • GradientBoostingRegressionmodel()
  • AdaBoostRegressionmodel()
  • XGBoostRegressionmodel()
  • ElasticNetRegressionmodel()

Classification Models

  • LogisticRegressionmodel()
  • KNeighborsClassifiermodel()
  • DecisionTreeClassifiermodel()
  • RandomForestClassifiermodel()
  • AdaBoostClassifiermodel()
  • GradientBoostingClassifiermodel()
  • XGBClassifiermodel()
  • SVClassifiermodel()

Utilities

1. Sampler

The Sampler class allows you to randomly select elements from:

  • Python lists
  • NumPy arrays
  • pandas DataFrames

It supports both stateless (reproducible) and stateful (streaming/simulation) modes.

Initialization

Sampler(data, n=1, random_state=None, replace=False, axis=0, stateful=False)

Parameters Explained

Parameter Type Description
data list, numpy.ndarray, pandas.DataFrame The dataset to sample from
n int Number of samples to return
random_state int or None Seed for reproducibility. Same seed = same result
replace bool If True, sampling is done with replacement (duplicates allowed). If False, no duplicates
axis int Only applies to DataFrames. 0 = sample rows, 1 = sample columns
stateful bool If True, RNG state continues across calls. If False, sampling is reproducible on every call

Example

from quicklearnkit import Sampler
import seaborn as sns

df = sns.load_dataset("tips")

sampler = Sampler(df, n=3, random_state=42, replace=False)

sample1 = sampler.sample()
sample2 = sampler.sample()  # Same output if stateful=False

2. Train–Test Split

Split datasets into training and testing sets with support for:

  • Shuffling
  • Stratification
  • NumPy arrays
  • pandas DataFrames

Function

train_test_split(data, test_size=0.25, shuffle=True, stratify=None, random_state=None)

Parameters Explained

Parameter Type Description
data array-like or pandas.DataFrame Dataset to split
test_size float Proportion of data to use as test set (e.g., 0.25 = 25%)
shuffle bool If True, data is shuffled before splitting
stratify array-like or str Column or labels to preserve class distribution in splits
random_state int or None Seed for reproducibility

Example

from quicklearnkit import train_test_split

train, test = train_test_split(df, test_size=0.3, shuffle=True, random_state=42)

3. ProbabilisticImputer

A group-aware, probabilistic categorical imputer. It learns probability distributions from observed data and fills missing values by sampling from those distributions.

This allows:

  • Realistic missing data handling
  • Teaching probability-based imputation
  • Reproducible preprocessing

Initialization

ProbabilisticImputer(group_col, target_col, random_state=None, stateful=False)

Parameters Explained

Parameter Type Description
group_col str Column used to group data (e.g., class, category)
target_col str Column where missing values will be imputed
random_state int or None Seed for reproducibility
stateful bool If True, RNG state advances across calls (useful for simulation). If False, output is reproducible

Methods

Method Description
fit(df) Learns probability distributions from known values
transform(df) Imputes missing values using learned distributions
fit_transform(df) Fit and transform in one step

Example

from quicklearnkit import ProbabilisticImputer
import seaborn as sns

df = sns.load_dataset("titanic")

imputer = ProbabilisticImputer(
    group_col="pclass",
    target_col="deck",
    random_state=42
)

imputed_df = imputer.fit_transform(df)

Plotting (Teaching-Friendly Visualization)

QuickLearnKit provides wrappers around seaborn + matplotlib that allow students to display values on plots using a simple switch:

show_values="yes"

All plotting functions:

  • Return a matplotlib Axes object
  • Allow full customization (labels, limits, grids, styles)
  • Automatically display the plot by default

Common Parameters (All Plot Functions)

Parameter Type Description
data pandas.DataFrame Dataset used for plotting
x str Column for x-axis
y str Column for y-axis (if applicable)
title str or None Plot title
show_values str "yes" or "no" — whether to display numeric values
fmt str Format string for value labels (e.g. {:.2f})
show bool If True, displays plot immediately. If False, returns Axes for customization

bar_plot

bar_plot(data, x, y, title=None, show_values="no", fmt="{:.1f}", show=True)

Example

from quicklearnkit import bar_plot
import seaborn as sns

_df = sns.load_dataset("tips")

ax = bar_plot(
    _df,
    x="day",
    y="total_bill",
    show_values="yes",
    show=False
)

ax.set_xlabel("Day of Week")
ax.set_ylabel("Average Bill")
ax.set_ylim(0, 40)

import matplotlib.pyplot as plt
plt.show()

line_plot

line_plot(data, x, y, title=None, show_values="no", fmt="{:.2f}", show=True)

scatter_plot

scatter_plot(data, x, y, title=None, show_values="no", fmt="{:.2f}", show=True)

count_plot

count_plot(data, x, title=None, show_values="no", show=True)

box_plot

Displays mean values when show_values="yes".

box_plot(data, x=None, y=None, title=None, show_values="no", fmt="{:.2f}", show=True)

hist_plot

Displays bin counts when show_values="yes".

hist_plot(data, x, bins=10, title=None, show_values="no", fmt="{:.0f}", show=True)

Random Data Generation

Generate random numerical arrays for experiments and demonstrations.

from quicklearnkit import create_random

random_data = create_random(mean=0, std_dev=1, size=100)

Design Philosophy

QuickLearnKit is designed for:

  • Students learning ML and data science
  • Educators teaching concepts, not boilerplate
  • Practitioners who want fast, clean workflows

It balances:

Beginner simplicity + Advanced control


Contributing

Want to improve QuickLearnKit?

  1. Fork the repository
  2. Create a feature branch
  3. Add tests and documentation
  4. Submit a pull request

License

MIT License


QuickLearnKit helps you move from learning to building faster — without sacrificing clarity or control. 🚀

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quicklearnkit-0.3.2.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

quicklearnkit-0.3.2-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file quicklearnkit-0.3.2.tar.gz.

File metadata

  • Download URL: quicklearnkit-0.3.2.tar.gz
  • Upload date:
  • Size: 14.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for quicklearnkit-0.3.2.tar.gz
Algorithm Hash digest
SHA256 81410d57a63b164e39419c332640ac702fe10f6749c45f807cfe9e1ca24acfe5
MD5 4e1d363bcbb9704f26101fe5d111c68a
BLAKE2b-256 98583d3cf49fa4064126910569acc57f95e5c9aa4e5023f21bf5776edf727968

See more details on using hashes here.

File details

Details for the file quicklearnkit-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: quicklearnkit-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for quicklearnkit-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2fccac8f8bb0b535b0cfd14a3af5eeabce91ada01789249c05019493b9b3e953
MD5 fd7413672d0b71f8c221d1e93ca26caa
BLAKE2b-256 71d8972cd4a520bf83ad8662906e13a8a5faa1e317a72ab5420211c195099338

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page