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.5.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.5.1.tar.gz (101.7 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.5.1-py3-none-any.whl (168.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vicentin-1.5.1.tar.gz
Algorithm Hash digest
SHA256 7caa30b3a964669e27cbfcadf5bb7cc60c56c3a645f2c707849c81d6482f9b20
MD5 258326f142770fd92889f55664d2ee27
BLAKE2b-256 08e7974f2d0bd5b163de8a1e724f26e37782b9327353c29a784a5b41f2bf6e4e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vicentin-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 168.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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 05f616ec5f8d05fdd2b6c073c57e639046b75fc5e6d953ad8fc36f449db9ddaf
MD5 f919f9b358f7ea9aca8e3021745184dc
BLAKE2b-256 ff2c5ba7368209207bb6e44c2ddd536d1cb625eff6dc6e8645093efd01ced998

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