diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..def0be4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,28 @@ +BSD 3-Clause License + +Copyright (c) 2024, The dlordinal developers + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.md b/README.md index 44e126b..6a4a91a 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,9 @@ The library includes various modules such as loss functions, models, layers, met | Overview | | |-----------|------------------------------------------------------------------------------------------------------------------------------------------| -| **CI/CD** | [![!codecov](https://img.shields.io/codecov/c/github/ayrna/dlordinal?label=codecov&logo=codecov)](https://codecov.io/gh/ayrna/dlordinal) [![!docs](https://readthedocs.org/projects/dlordinal/badge/?version=latest&style=flat)](https://dlordinal.readthedocs.io/en/latest/) | +| **CI/CD** | [![!codecov](https://img.shields.io/codecov/c/github/ayrna/dlordinal?label=codecov&logo=codecov)](https://codecov.io/gh/ayrna/dlordinal) [![!docs](https://readthedocs.org/projects/dlordinal/badge/?version=latest&style=flat)](https://dlordinal.readthedocs.io/en/latest/) [![!python](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/) | | **Code** | [![![binder]](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ayrna/dlordinal/main?filepath=tutorials) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Linter: Ruff](https://img.shields.io/badge/Linter-Ruff-brightgreen?style=flat-square)](https://github.com/charliermarsh/ruff) | - ## ⚙️ Installation You can install **dlordinal** directly from the GitHub repository using the following command in your terminal: @@ -19,11 +18,8 @@ You can install **dlordinal** directly from the GitHub repository using the foll Also, you can clone the repository and then install the library from the local repository folder: - cd ~ git clone git@github.com:ayrna/dlordinal.git - pip install -e ~/dlordinal - -Using the -e argument with pip install, does an editable installation, allowing the changes obtained through the repository to be automatically applied to the installed version of the library. + pip install ./dlordinal ## Collaborating diff --git a/pyproject.toml b/pyproject.toml index e099fc9..4d54525 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,8 +6,9 @@ build-backend = "setuptools.build_meta" name = "dlordinal" version = "1.0.0" authors = [ - {name = "Francisco Bérchez", email = "i72bemof@uco.es"}, - {name = "Víctor Vargas", email = "vvargas@uco.es"}, + {name = "Francisco Bérchez-Moreno", email = "i72bemof@uco.es"}, + {name = "Víctor Manuel Vargas", email = "vvargas@uco.es"}, + {name = "Javier Barbero-Gómez", email = "jbarbero@uco.es"}, ] description = "Deep learning for ordinal classification" readme = "README.md"