Metadata-Version: 2.3
Name: scio-pypi
Version: 1.0.1
Summary: Statistical Confidence from Internal Observations
Keywords: out-of-distribution detection,machine learning,statistics
Author: Élie Goudout
Author-email: Élie Goudout <elie.goudout@thalesgroup.com>
License: Copyright 2024–2025 THALES
         
         Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Pytest
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Dist: dill>=0.3.8
Requires-Dist: faiss-cpu>=1.12
Requires-Dist: lazy-loader>=0.4
Requires-Dist: matplotlib>=3.10
Requires-Dist: numpy>=2.2.2
Requires-Dist: pandas>=2.2.3
Requires-Dist: paramclasses>=0.4.0
Requires-Dist: rich>=13.9.4
Requires-Dist: scikit-learn>=1.7.2
Requires-Dist: scipy>=1.16
Requires-Dist: seaborn>=0.13.2
Requires-Dist: torch>=2.6
Requires-Dist: torchinfo>=1.8
Maintainer: Élie Goudout, Élie Goudout
Maintainer-email: Élie Goudout <elie.goudout@thalesgroup.com>, Élie Goudout <eliegoudout@hotmail.com>
Requires-Python: >=3.12, <3.15
Description-Content-Type: text/markdown

[![os][os_img]][os_target]
[![python][python_img]][python_target]
[![pypi][pypi_img]][pypi_target]
[![typed][typed_img]][typed_target]
[![license][license_img]][license_target]
[![doi][doi_img]][doi_target]
[![pipeline][pipeline_img]][pipeline_target]
[![coverage][coverage_img]][coverage_target]
[![ruff][ruff_img]][ruff_target]
[![uv][uv_img]][uv_target]

[os_img]: https://img.shields.io/badge/cross--platform-%E2%9C%93-blue "Tested on Ubuntu & Windows"
[os_target]: https://sciortd.readthedocs.io/stable/user_guide/installation_compatibility.html#os-compatibility

[python_img]: https://img.shields.io/badge/python-3.12%20|%203.13%20|%203.14-blue "Compatible Python versions"
[python_target]: https://devguide.python.org/versions

[pypi_img]: https://img.shields.io/pypi/v/scio-pypi "Latest PyPI release"
[pypi_target]: https://pypi.org/project/scio-pypi

[typed_img]: https://img.shields.io/pypi/types/scio-pypi "This package is typed"
[typed_target]: https://peps.python.org/pep-0561

[license_img]: https://img.shields.io/github/license/ThalesGroup/scio "Distributed under"
[license_target]: https://github.com/ThalesGroup/scio?tab=MIT-1-ov-file#MIT-1-ov-file

[doi_img]: https://zenodo.org/badge/DOI/10.5281/zenodo.17160013.svg "Zenodo archive"
[doi_target]: https://doi.org/10.5281/zenodo.17160013

[pipeline_img]: https://github.com/ThalesGroup/scio/actions/workflows/ci.yml/badge.svg?branch=release "Pipeline status"
[pipeline_target]: https://github.com/ThalesGroup/scio/actions

[coverage_img]: https://codecov.io/github/ThalesGroup/scio/graph/badge.svg?token=7L1KWAHGR6 "Test coverage"
[coverage_target]: https://codecov.io/github/ThalesGroup/scio

[ruff_img]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json "Linted and formatted with Ruff"
[ruff_target]: https://github.com/astral-sh/ruff#readme

[uv_img]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json "Developed with uv"
[uv_target]: https://github.com/astral-sh/uv#readme

<!-- End of Badges -->


# `scio`

<div align="center">
  <h3>Confidence scores for Neural Networks, made easy!</h3>
  <p><i>“<strong>scio</strong> me nihil scire”</i></p>

  <p align="center">
    <a href="https://sciortd.readthedocs.io"><strong>Explore the Docs »</strong></a>
    <br />
    <a href="https://github.com/ThalesGroup/scio/issues/new?labels=question">Ask Help</a>
    &middot;
    <a href="https://github.com/ThalesGroup/scio/issues/new?template=feature_request.yml">Request Feature</a>
    &middot;
    <a href="https://github.com/ThalesGroup/scio/issues/new?template=bug_report.yml">Report Bug</a>
  </p>
</div>

```bash
# Install from PyPI
pip install scio-pypi
```

----

### Demo 🎮
<p align="center">
  <a href="https://sciortd.readthedocs.io/stable/auto_tutorials/visualizing_and_evaluating_ood_detection_algorithms.html"
     title="Click to follow along the tutorial!">
    <img src="https://github.com/ego-thales/scio-assets/blob/main/assets/demo.gif" alt="demo gif">
  </a>
</p>


### Documentation 📖
The full documentation can be found [**here**][docs]. You may learn more [about scio][about], [get started][get_started] and follow [tutorials], or specifically browse [API references][api] and scientific literature [references].

### Citing `scio` 🎓
<!-- START CITING -->
If our library contributed to your research or project, please consider citing it. For convenience, we provide the following BibTeX entry for the entire code base. 
```BibTeX
@software{ThalesGroup/scio,
  title = {scio: {C}onfidence scores for {N}eural {N}etworks, made easy!},
  author = {Élie Goudout and the scio community},
  url = {github.com/ThalesGroup/scio},
  doi = {10.5281/zenodo.17160013},
  year = {2025}
}
```
To reference a particular release, get the DOI <a href="https://zenodo.org/search?q=parent.id%3A17160013&f=allversions%3Atrue&l=list&p=1&s=10&sort=version" title="Browse all releases">here</a>.
<!-- END CITING -->

### Contributing 💫
Questions, [issues], [discussions] and [pull requests][pulls] are welcome! Read our [contributing guide](CONTRIBUTING.md) and join our team of [contributors] ✨

For development, we recommend using `uv` since we ship `uv.lock` for better development reproducibility.

### Star history ⭐
<picture>
  <source media="(prefers-color-scheme: dark)"
          srcset="https://api.star-history.com/svg?repos=ThalesGroup/scio&type=Date&theme=dark" />
  <img alt="Star History Chart"
       src="https://api.star-history.com/svg?repos=ThalesGroup/scio&type=Date"
       title="Help me grow! Feed me a ⭐" />
</picture>

### License ⚖️
This package is distributed under the [MIT license](LICENSE). The use of NVIDIA proprietary modules (for GPU acceleration) is optional.

<!-- References -->
[docs]: https://sciortd.readthedocs.io
[about]: https://sciortd.readthedocs.io/stable/user_guide/what_is_scio.html#what-is-scio
[get_started]: https://sciortd.readthedocs.io/stable/user_guide/installation_compatibility.html#installation-compatibility
[tutorials]: https://sciortd.readthedocs.io/stable/auto_tutorials/index.html
[api]: https://sciortd.readthedocs.io/stable/api_references.html
[references]: https://sciortd.readthedocs.io/stable/bib_references.html
[citing]:  https://sciortd.readthedocs.io/stable/citing_scio.html
[issues]: https://github.com/ThalesGroup/scio/issues
[discussions]: https://github.com/ThalesGroup/scio/discussions
[pulls]: https://github.com/ThalesGroup/scio/pulls
[contributors]: https://sciortd.readthedocs.io/stable/contributors.html
