crepes 项目教程

crepes 项目教程

crepes Conformal classifiers, regressors and predictive systems 项目地址: https://gitcode.com/gh_mirrors/cr/crepes

1. 项目目录结构及介绍

crepes 项目的目录结构如下：

crepes/
├── docs/
├── src/
│   └── crepes/
│       ├── __init__.py
│       ├── ...
├── CHANGELOG.md
├── LICENSE
├── README.md
├── pyproject.toml
└── setup.py

目录结构介绍

• docs/: 存放项目的文档文件，通常包含项目的详细说明、API文档等。
• src/crepes/: 项目的源代码目录，包含主要的Python模块和包。
  • init.py: 初始化文件，使得 src/crepes 成为一个Python包。
  • ...: 其他Python文件和子目录，包含项目的核心功能实现。
• CHANGELOG.md: 记录项目的版本变更历史。
• LICENSE: 项目的开源许可证文件，通常为BSD-3-Clause许可证。
• README.md: 项目的介绍文件，包含项目的基本信息、安装方法、使用说明等。
• pyproject.toml: 项目的配置文件，用于定义项目的构建系统和依赖。
• setup.py: 项目的安装脚本，用于将项目打包并安装到Python环境中。

2. 项目的启动文件介绍

crepes 项目没有明确的“启动文件”，因为它是一个Python包，通常通过导入模块来使用。项目的核心功能分布在 src/crepes 目录下的多个Python文件中。

主要模块介绍

• crepes.py: 包含主要的类和函数，用于实现conformal prediction的功能。
• crepes/extras.py: 提供一些标准的选项，用于计算难度估计、非一致性分数和Mondrian类别。

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 crepes 项目的配置文件，用于定义项目的构建系统和依赖。以下是文件的主要内容：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "crepes"
version = "0.1.0"
description = "Python package for conformal prediction"
authors = [
    { name="Henrik Boström", email="henrik.bostrom@kth.se" }
]
license = { file="LICENSE" }
readme = "README.md"
requires-python = ">=3.6"
dependencies = [
    "numpy",
    "scikit-learn",
    "pandas"
]

配置文件介绍

• [build-system]: 定义了构建系统的要求和后端。
• [project]: 定义了项目的基本信息，如名称、版本、描述、作者、许可证、Python版本要求和依赖项。

setup.py

setup.py 是项目的安装脚本，用于将项目打包并安装到Python环境中。以下是文件的主要内容：

from setuptools import setup, find_packages

setup(
    name='crepes',
    version='0.1.0',
    description='Python package for conformal prediction',
    author='Henrik Boström',
    author_email='henrik.bostrom@kth.se',
    license='BSD-3-Clause',
    packages=find_packages(where='src'),
    package_dir={'': 'src'},
    install_requires=[
        'numpy',
        'scikit-learn',
        'pandas'
    ],
    classifiers=[
        'Development Status :: 3 - Alpha',
        'Intended Audience :: Developers',
        'License :: OSI Approved :: BSD License',
        'Programming Language :: Python :: 3',
        'Programming Language :: Python :: 3.6',
        'Programming Language :: Python :: 3.7',
        'Programming Language :: Python :: 3.8',
        'Programming Language :: Python :: 3.9',
    ],
)

配置文件介绍

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的简短描述。
• author: 项目的作者。
• author_email: 作者的电子邮件地址。
• license: 项目的许可证。
• packages: 需要包含的Python包。
• package_dir: 指定包的目录。
• install_requires: 项目依赖的其他Python包。
• classifiers: 项目的分类信息，用于帮助PyPI和其他工具识别项目的特性。

crepes Conformal classifiers, regressors and predictive systems 项目地址: https://gitcode.com/gh_mirrors/cr/crepes