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

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.4.19.tar.gz (97.5 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.4.19-py3-none-any.whl (161.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vicentin-1.4.19.tar.gz
Algorithm Hash digest
SHA256 529ca2d40aa5ec2c82f4574adeb9927229a0a3016b24ced373f527339f24e236
MD5 135d46d5e856bf0ab0a3df5713f6ef2f
BLAKE2b-256 ea5d23abee8304cc219dcce53def65448d610d2a8b4cc5875797353ee9205480

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vicentin-1.4.19-py3-none-any.whl
  • Upload date:
  • Size: 161.9 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.4.19-py3-none-any.whl
Algorithm Hash digest
SHA256 9fad86b8d35beaea0feabebb6aae418ff203586de40f9ea2a7bef4d47554220c
MD5 5f9aff72642e4571daaf0b3a1f914bce
BLAKE2b-256 0167b5cc61573fa8dd6e619d110d9e691544bded14f4fff9494a76b7191e1e64

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