Skip to main content

Personal collection of algorithms.

Project description

Vicentin

A comprehensive Python library for mathematical optimization, deep learning, computer vision, and classic algorithms. This library is designed with a dual-backend architecture, offering seamless switching between NumPy for transparency and PyTorch for hardware acceleration and automatic differentiation.

CI License: MIT PyPI - Version


Table of Contents


Introduction

vicentin is a Python package that contains my personal implementations of a variety of algorithms, data structures, and optimization techniques. It serves as a collection of theoretical and practical programming concepts.


Features


Installation

1️⃣ Clone the Repository

git clone https://github.com/your-username/vicentin.git
cd vicentin

2️⃣ Set Up a Virtual Environment

python -m venv venv
source venv/bin/activate

3️⃣ Install Dependencies

pip install -r requirements.txt

Usage

Heap data structure

# Example: Using the heap data structure
from vicentin.data_structures.heap import Heap

heap = Heap()
heap.insert(5)
heap.insert(2)
heap.insert(8)

print(heap.extract_min())  # Output: 2

Newton's Method

import torch
from vicentin.optimization.minimization import newton_method

def objective(x):
    return torch.sum(x**2)

x0 = torch.tensor([10.0, 10.0])
A = torch.tensor([[1.0, 1.0]])
b = torch.tensor([1.0])

# Backend (Torch) is automatically detected from x0
x_opt = newton_method(objective, x0, equality=(A, b))
print(f"Optimal solution: {x_opt}")

Pre-commit Setup

This repository uses pre-commit to enforce coding standards, automatic formatting and automatic version bumping before commits.

1️⃣ Install pre-commit

pip install pre-commit

2️⃣ Install Hooks

pre-commit install

3️⃣ Use commitizen to commit

cz commit

License

This project is licensed under the MIT License.

Project details


Release history Release notifications | RSS feed

This version

1.3.1

Download files

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

Source Distribution

vicentin-1.3.1.tar.gz (84.3 kB view details)

Uploaded Source

Built Distribution

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

vicentin-1.3.1-py3-none-any.whl (135.8 kB view details)

Uploaded Python 3

File details

Details for the file vicentin-1.3.1.tar.gz.

File metadata

  • Download URL: vicentin-1.3.1.tar.gz
  • Upload date:
  • Size: 84.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for vicentin-1.3.1.tar.gz
Algorithm Hash digest
SHA256 68dbfb1a935caa8762175815d9d6e4b2064ceda6612e6546e99a71109658153c
MD5 5db3c6a701adde6e934432b2b44db1a7
BLAKE2b-256 c473b1cd1d7a2ff34cf5fd04af7404d9186e354852d1010dedfaa239b13956e5

See more details on using hashes here.

File details

Details for the file vicentin-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: vicentin-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 135.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for vicentin-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e84a066217e53407541b2953429d3d52956bea4b3a8ce00dad5dae20ccacad4d
MD5 eaeb9a5ff1ccf571c33205c355d26a93
BLAKE2b-256 8b986f06bcbf8194641199cfbbb7b3bf14c0eaa036fa95559815f3299d8eeeb2

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