Skip to content

Home

Jump to bottom
Shourya Shashank edited this page Jul 7, 2024 · 1 revision

Home

Welcome to the Predacons Wiki! Predacons is a Python library based on transformers used for transfer learning. It simplifies the process of applying advanced machine learning techniques to your projects with a suite of tools for data processing, model training, and text generation.

Quick Links

  • Installation
  • Usage
  • Features
  • Contributing
  • License

Installation

To install Predacons, run the following command in your terminal:

pip install predacons

Ensure you have Python 3.10 or later installed to use Predacons.

Usage

Here's how to get started with Predacons:

Initialize the Library

from predacons import predacons
predacons.rollout()

Load Documents

# From a directory
predacons.read_documents_from_directory('your/directory/path')

Clean Text Data

cleaned_text = predacons.clean_text("Your dirty text here")

Train a Model

predacons.train(train_file_path="path/to/train/file",
                model_name="your_model_name",
                output_dir="path/to/output/dir",
                overwrite_output_dir=True,
                per_device_train_batch_size=4,
                num_train_epochs=3,
                save_steps=100)

Generate Text

generated_text = predacons.generate_text(model_path="path/to/your/model",
                                         sequence="Seed text for generation",
                                         max_length=50)

Features

Predacons offers a comprehensive set of features:

  • Data Loading: Load data from directories or files.
  • Text Cleaning: Clean text data with built-in functions.
  • Model Training: Train transformer models with custom data.
  • Text Generation: Generate text using trained models.

Contributing

We welcome contributions! If you have suggestions for improvements or new features, please open an issue first to discuss your ideas. For code contributions, submit a pull request.

License

Predacons is licensed under multiple licenses:

  • Free users: GNU Affero General Public License (AGPL).
  • Paid users: Options for a perpetual or yearly commercial license.

Please ensure you understand and comply with the license that applies to you.

This wiki serves as a guide for users and contributors of the Predacons library. For more detailed information, refer to the official documentation and the README file in the GitHub repository.

This wiki serves as a guide for users and contributors of the Predacons library. For more detailed information, refer to the official documentation and the README file in the GitHub repository.

Clone this wiki locally