# AdaptFTIR
## Description
This repository contains a Python implementation of the AdaptFTIR method described in the paper entitled "**Title**" (doi url).
## Installation
The package is available via PyPI:
```bash
pip install AdaptFTIR
```
## Usage
For detailed information on how to initialize the AdaptFTIR method and configure its parameters, please refer to the `example_usage.ipynb` Jupyter Notebook and the code documentation in the `AdaptFTIR.py` file. The basic usage format is as follows:
```python
from AdaptFTIR import AdaptFTIR
# Initialize an instance of AdaptFTIR with a calibration set
adapter = AdaptFTIR(spectra=<your_spectra_to_augment>,
subject_ids=<your_subject_ids_for_spectra_to_augment>,
calibration_set=<your_calibration_set>,
calibration_ids=<your_calibration_set_subject_ids>)
# Create synthetic samples based on an input set of training samples X and associated sample labels y
X_gen, y_gen = AdaptFTIR.run(n_per_subject_id=<your_n_per_subject_id>)
```
## Citation
> Citation goes here
Raw data
{
"_id": null,
"home_page": "https://github.com/Niklas-LK/AdaptFTIR",
"name": "AdaptFTIR",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Niklas Leopold-Kerschbaumer",
"author_email": "niklas.leopold-kerschbaumer@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/31/a7/5636b8fd6860ecc0a71b44016c72f84e9ddfed9fe08024f299b97826e6f4/AdaptFTIR-0.1.0.tar.gz",
"platform": null,
"description": "# AdaptFTIR\r\n\r\n## Description\r\nThis repository contains a Python implementation of the AdaptFTIR method described in the paper entitled \"**Title**\" (doi url).\r\n\r\n## Installation\r\nThe package is available via PyPI:\r\n```bash\r\npip install AdaptFTIR\r\n```\r\n\r\n## Usage\r\nFor detailed information on how to initialize the AdaptFTIR method and configure its parameters, please refer to the `example_usage.ipynb` Jupyter Notebook and the code documentation in the `AdaptFTIR.py` file. The basic usage format is as follows:\r\n```python\r\nfrom AdaptFTIR import AdaptFTIR\r\n\r\n# Initialize an instance of AdaptFTIR with a calibration set\r\nadapter = AdaptFTIR(spectra=<your_spectra_to_augment>,\r\n subject_ids=<your_subject_ids_for_spectra_to_augment>,\r\n calibration_set=<your_calibration_set>,\r\n calibration_ids=<your_calibration_set_subject_ids>)\r\n\r\n# Create synthetic samples based on an input set of training samples X and associated sample labels y\r\nX_gen, y_gen = AdaptFTIR.run(n_per_subject_id=<your_n_per_subject_id>)\r\n\r\n```\r\n\r\n## Citation\r\n> Citation goes here\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Domain adaptation for FTIR spectra",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/Niklas-LK/AdaptFTIR"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c430e0a445527777a808470920d9acf4f3292cd39a76a436ee842be0ad197cc",
"md5": "d5dec5134bb5884c77f70770bed5abef",
"sha256": "04021124e0c912825fd4c7d89fdd1342b9ee1d66f422efc7c1a4ccc654d06c37"
},
"downloads": -1,
"filename": "AdaptFTIR-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5dec5134bb5884c77f70770bed5abef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4942,
"upload_time": "2024-08-20T08:39:00",
"upload_time_iso_8601": "2024-08-20T08:39:00.668816Z",
"url": "https://files.pythonhosted.org/packages/5c/43/0e0a445527777a808470920d9acf4f3292cd39a76a436ee842be0ad197cc/AdaptFTIR-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "31a75636b8fd6860ecc0a71b44016c72f84e9ddfed9fe08024f299b97826e6f4",
"md5": "94077304b255837495adc5213ce6452d",
"sha256": "17f0c4d9f597d0a50b91df71d61d72636b78d1527a7ea3fd0a98ebea33996015"
},
"downloads": -1,
"filename": "AdaptFTIR-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "94077304b255837495adc5213ce6452d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4677,
"upload_time": "2024-08-20T08:39:01",
"upload_time_iso_8601": "2024-08-20T08:39:01.840181Z",
"url": "https://files.pythonhosted.org/packages/31/a7/5636b8fd6860ecc0a71b44016c72f84e9ddfed9fe08024f299b97826e6f4/AdaptFTIR-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-20 08:39:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Niklas-LK",
"github_project": "AdaptFTIR",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "adaptftir"
}