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.6.16.tar.gz (108.8 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.6.16-py3-none-any.whl (182.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vicentin-1.6.16.tar.gz
Algorithm Hash digest
SHA256 5a637a9c246a10d781aeb48a69223dac10f1aac3141623eefa40d0ec86b279c2
MD5 5055c6e908482c4127c45773b4d54236
BLAKE2b-256 4b38729227605d2759a341a99b70270cd70792894ae7e0897252dadeab971706

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vicentin-1.6.16-py3-none-any.whl
  • Upload date:
  • Size: 182.7 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.6.16-py3-none-any.whl
Algorithm Hash digest
SHA256 a59dcff2bfe290ec7d932f7840685304258f47892f8a1b87c7b66904d0bb8793
MD5 f1723d45e9d8e3e8f0fa9849165ccd32
BLAKE2b-256 6d18de858e67929548e803eb8826cc4b9d24a1c51b283a0e073cddabbc4b7f15

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