Skip to main content

flex-nlp

The flex-nlp package consists of a set of tools and utilities to work with Natural Language Processing (NLP) datasets and models. It is designed to be used with the FLEXible framework, as it is an extension of it.

flex-nlp comes with some tools to work with NLP datasets, that are the following ones:

  • ss_triplet_input_adapter a Semantic Textual Similarity (STS) dataset adapter: It is a dataset adapter that allows to work with the TripletQQP dataset and other datasets that are similar to it.
  • default_data_collator_classification: It is a data collator that allows to work with the classification task, and it is the default data collator for the classification task.
  • basic_collate_pad_sequence_classification: It is a data collator that allows to work with the classification task, and it is a basic data collator for the classification task. This collator pads the sequences to the maximum length of the batch, and it puts the batch dimension in the first position.

We also provide an aggregator to work with neural networks, clip_avg. Alonside, we have used some aggregator available in the FLEXible framework.

Aggregator Description Citation
clip_avg It is a federated aggregator that clips the weights recieved by the clients, averaging only those that surpass a selected threshold. Reviewing Federated Learning Aggregation Algorithms; Strategies, Contributions, Limitations and Future Perspectives
fedavg It is a federated aggregator that compute the mean of the weights recieved by the clients. Communication-Efficient Learning of Deep Networks from Decentralized Data
weighted_avg Similar to fedavg, it is a federated aggregator that add weights to the clients in order of giving more importance to some clients than to another clients. Communication-Efficient Learning of Deep Networks from Decentralized Data

 Tutorials

To get started with flex-nlp, you can check the notebooks available in the repository. They cover the following topics:

In the following we detail the tasks, models, and the datasets used in the notebooks:

Task Model Dataset
Sentiment Analysis (SA) BiGRU IMDb
Question Answering (QA) DistilBERT SQuAD
Semantic Textual Similarity (STS) DistilRoberta QQP-Triplets

Installation

We recommend Anaconda/Miniconda as the package manager. The following is the corresponding flex-nlp versions and supported Python versions.

flex flex-nlp Python
main / nightly main / nightly >=3.8, <=3.11
v0.6.0 v0.1.0 >=3.8, <=3.11

To install the package, you can use the following commands:

Using pip:

pip install flexnlp

Download the repository and install it locally:

git clone git@github.com:FLEXible-FL/flex-nlp.git
cd flex-nlp
pip install -e .

## Citation

If you use this package, please cite the following paper:

TODO: Add citation

Release files for flexnlp 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flexnlp 0.1.0
File Size Uploaded
flexnlp-0.1.0.tar.gz 20.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for flexnlp 0.1.0
File Interpreter ABI Platform
flexnlp-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 43.7 kB

Release files / flexnlp-0.1.0.tar.gz

Download URL flexnlp-0.1.0.tar.gz
Size 20.1 kB
Tags Source
SHA-256 checksum
How to use checksums
fc38244f3a6def70a22b229e127aac601ca19a00355f7f84a29704854ae153c1
BLAKE2b-256 checksum
How to use checksums
3b17c88b1eb89718c7bccd5ddceeaf0476c8929b499d8e4ddd56362094e25686
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.4

Release files / flexnlp-0.1.0-py3-none-any.whl

Download URL flexnlp-0.1.0-py3-none-any.whl
Size 23.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1f0abd84235bb22d4671aafb3cd6b350ba0644fc4e2bbe37421ec609d7a818e8
BLAKE2b-256 checksum
How to use checksums
b18025a16dda8025e7910f714ea162532b9fd2da9a2e3c4b8b04f21c41ca72d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page