Skip to content

Commit

Permalink
[MRG] Release 0.3.0, pyproject.toml an Citations files (#215)
Browse files Browse the repository at this point in the history
* add citation file annd set proper versions for skada

* affiliation florent

* add pyporject.toml

* ste minimal setup.py for legacy pip

* select package manually

* add classifiers

* upate license

* add bibtex to readme
  • Loading branch information
rflamary authored Jul 5, 2024
1 parent 0d9c6b1 commit bfd487e
Show file tree
Hide file tree
Showing 7 changed files with 144 additions and 35 deletions.
62 changes: 62 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: 'SKADA : Scikit Adaptation'
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Théo
family-names: Gnassounou
affiliation: University Paris-Saclay, Inria, CEA
- given-names: Oleksii
family-names: Kachaiev
- given-names: Rémi
family-names: Flamary
affiliation: 'École Polytechnique, IP Paris'
- given-names: Antoine
family-names: Collas
affiliation: 'University Paris-Saclay, Inria, CEA'
- given-names: Yanis
family-names: Lalou
affiliation: 'École Polytechnique, IP Paris'
- given-names: Antoine
name-particle: de
family-names: Mathelin
affiliation: 'ENS Paris Saclay'
- given-names: Alexandre
family-names: Gramfort
affiliation: 'University Paris-Saclay, Inria, CEA'
- given-names: Ruben
family-names: Bueno
affiliation: 'École Polytechnique, IP Paris'
- given-names: Florent
family-names: Michel
affiliation: 'University Paris-Saclay, Inria, CEA'
- given-names: Apolline
family-names: Mellot
affiliation: 'University Paris-Saclay, Inria, CEA'
- given-names: Virginie
family-names: ' Loison'
affiliation: 'University Paris-Saclay, Inria, CEA'
- given-names: Ambroise
family-names: Odonnat
affiliation: Huawei Noah’s Ark Lab
- given-names: Thomas
family-names: Moreau
affiliation: 'University Paris-Saclay, Inria, CEA'
repository-code: 'https://github.com/scikit-adaptation/skada/'
url: 'https://scikit-adaptation.github.io/'
abstract: >-
Python Domain Adaptation toolbow compatible with
scikit-learn and PyTorch
keywords:
- machine learning
- scikit-learn
- pytorch
- domain adaptation
license: BSD-3-Clause
version: 0.3.0
date-released: 2024-07-04
2 changes: 1 addition & 1 deletion COPYING
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2023 The scikit-adaptation developers.
Copyright (c) 2023 The SKADA developers.
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,25 @@ compatible API with the following features:
- Classifier/Regressor and data Adapter DA algorithms compatible with scikit-learn pipelines.
- Compatible with scikit-learn validation loops (cross_val_score, GridSearchCV, etc).

**Citation**: If you use this library in your research, please cite the following reference:

```
Gnassounou T., Kachaiev O., Flamary R., Collas A., Lalou Y., de Mathelin A., Gramfort A., Bueno R., Michel F., Mellot A., Loison V., Odonnat A., Moreau T. (2024). SKADA : Scikit Adaptation (version 0.3.0). URL: https://scikit-adaptation.github.io/
```

or in Bibtex format :

```bibtex
@misc{gnassounou2024skada,
author = {Gnassounou, Théo and Kachaiev, Oleksii and Flamary, Rémi and Collas, Antoine and Lalou, Yanis and de Mathelin, Antoine and Gramfort, Alexandre and Bueno, Ruben and Michel, Florent and Mellot, Apolline and Loison, Virginie and Odonnat, Ambroise and Moreau, Thomas},
month = {7},
title = {SKADA : Scikit Adaptation},
url = {https://scikit-adaptation.github.io/},
year = {2024}
}
```


## Implemented algorithms

The following algorithms are currently implemented.
Expand Down
14 changes: 0 additions & 14 deletions environment.yml

This file was deleted.

60 changes: 60 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@


[build-system]
requires = ["setuptools", "setuptools-scm"]
build-backend = "setuptools.build_meta"


[project]
dynamic = ["version"]
name = "skada"
description = "A Python package for domain adaptation compatible with scikit-learn and Pytorch."
authors = [
{name = "SKADA Team"},
]
license = {file = "COPYING"}
readme = "README.md"
dependencies = [
"numpy >= 1.24",
"scipy >= 1.10",
"scikit-learn >= 1.4.0",
"POT >= 0.9.3",
]
keywords = ["domain-adaptation", "scikit-learn", "pytorch",
"machine learning", "deep learning"]
classifiers=[
"Intended Audience :: Science/Research",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Programming Language :: C",
"Programming Language :: Python",
"Topic :: Software Development",
"Topic :: Scientific/Engineering",
"Development Status :: 3 - Alpha",
"Operating System :: Microsoft :: Windows",
"Operating System :: POSIX",
"Operating System :: Unix",
"Operating System :: MacOS",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]

[project.urls]
homepage = "https://scikit-adaptation.github.io/"
documentation = "https://scikit-adaptation.github.io/"
repository = "https://github.com/scikit-adaptation/skada/"

# Optional dependencies
[project.optional-dependencies]
all = ["torch", "torchvision", "skorch"]
deep = ["torch", "torchvision", "skorch"]
subspace = ["torch"]

[tool.setuptools]
packages = ["skada"]

[tool.setuptools.dynamic]
version = {attr = "skada.version.__version__"}
20 changes: 1 addition & 19 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
from setuptools import find_packages, setup

setup(
name='skada',
version='0',
description='A domain adaptation toolbox to reduce shift between domains.',

# The project's main homepage.
url='https://github.com/scikit-adaptation/skada',

# Author details
author='Théo Gnassounou',
author_email='[email protected]',

# Choose your license
license='BSD 3-Clause',
# What does your project relate to?
keywords='domain adaptation, machine learning, deep-learning',

packages=find_packages(),
)
setup()
2 changes: 1 addition & 1 deletion skada/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
#
# License: BSD 3-Clause

__version__ = "0.2"
__version__ = "0.3.0"

0 comments on commit bfd487e

Please sign in to comment.