Skip to main content

Python package for the creation of recommendation systems based on user traces.

Project description

tracerec

Python package for the creation of recommendation systems based on user traces.

Inslation

With pip:

pip install tracerec

With Poetry:

poetry add tracerec

Development

For contributing to the development of this package, you can clone the repository and install the dependencies using Poetry.

# Clone the repository
git clone https://github.com/almtav08/tracerec.git
cd tracerec

# Install dev dependencies
poetry install

Usage

from tracerec.algorithms.knowledge_based.transe import TransE
from tracerec.data.triples.triples_manager import TriplesManager
from tracerec.samplers.negative_triple_sampler import NegativeTripleSampler

triples = [
        (1, 0, 2),
        (2, 0, 3),
        (3, 0, 4)
    ]
triples_manager = TriplesManager(triples)

train_x, train_y, test_x, test_y = triples_manager.split(train_ratio=0.8, relation_ratio=True, random_state=42, device='cpu')

# Test negative sampling
sampler = NegativeTripleSampler(train_x, triples_manager, strategy='random', device='cpu')
train_x_neg = sampler.sample(num_samples=1, random_state=42)

transe = TransE(num_entities=4, num_relations=1, embedding_dim=10, device='cpu', norm=1)
transe.compile(optimizer=torch.optim.Adam, criterion=torch.nn.MarginRankingLoss(margin=1.0))

transe.fit(train_x, train_x_neg, train_y, num_epochs=1, batch_size=1, lr=0.001, verbose=True)

License

MIT

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

tracerec-0.2.0.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

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

tracerec-0.2.0-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file tracerec-0.2.0.tar.gz.

File metadata

  • Download URL: tracerec-0.2.0.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tracerec-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f27f01c65408b6b7473599355b9efa34809381714178ddac9c02452950de2eef
MD5 ae5ebff6e342b39276ab22079a81c465
BLAKE2b-256 6afdb4e7ae9727d0c26807a459bcdeeb0ad666aff4678305605fa1717dde616b

See more details on using hashes here.

Provenance

The following attestation bundles were made for tracerec-0.2.0.tar.gz:

Publisher: python-publish.yml on almtav08/tracerec

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tracerec-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: tracerec-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for tracerec-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 63cf252ed72e059ad52affe57bedc6f43e9de1e090ec7fd77923332005cbec8f
MD5 f5dd3bffda18af3858dddcb020ca9e54
BLAKE2b-256 6bfbc9109d3c13b0fc1a2b65ccec2326ea938b5262d96825ebaea03b417031ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for tracerec-0.2.0-py3-none-any.whl:

Publisher: python-publish.yml on almtav08/tracerec

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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