Fusilli 开源项目使用教程

fusilli A Python package housing a collection of deep-learning multi-modal data fusion method pipelines! From data loading, to training, to evaluation - fusilli's got you covered 🌸 项目地址: https://gitcode.com/gh_mirrors/fu/fusilli

1. 项目的目录结构及介绍

Fusilli 项目的目录结构如下：

fusilli/ ├── docs/ ├── fusilli/ │ ├── fusionmodels/ │ ├── data/ │ ├── train/ │ ├── eval/ │ └── __init__.py ├── tests/ ├── .gitignore ├── .gitmodules ├── readthedocs.yaml ├── LICENSE ├── README.md └── pyproject.toml

目录结构介绍

docs/: 存放项目的文档文件，通常用于生成项目的文档网站。
fusilli/: 项目的主要代码目录，包含了数据处理、模型训练、评估等模块。
- fusionmodels/: 存放多模态数据融合模型的实现代码。
- data/: 存放数据处理相关的代码。
- train/: 存放模型训练相关的代码。
- eval/: 存放模型评估相关的代码。
- init.py: 使 fusilli 目录成为一个 Python 包。
tests/: 存放项目的测试代码。
.gitignore: 指定 Git 版本控制系统忽略的文件和目录。
.gitmodules: 用于管理 Git 子模块。
readthedocs.yaml: 配置 Read the Docs 文档生成工具的文件。
LICENSE: 项目的开源许可证文件，本项目使用 AGPL-3.0 许可证。
README.md: 项目的介绍文件，通常包含项目的基本信息、安装方法、使用示例等。
pyproject.toml: 项目的配置文件，用于指定项目的依赖、构建工具等信息。

2. 项目的启动文件介绍

Fusilli 项目没有明确的“启动文件”，因为它的使用方式是通过导入模块并调用相应的函数来实现的。例如，你可以通过以下方式启动模型的训练：

from fusilli.data import prepare_fusion_data from fusilli.train import train_and_save_models # 准备数据 data_module = prepare_fusion_data( prediction_task="regression", fusion_model=ExampleModel, data_paths=data_paths, output_paths=output_paths ) # 训练模型 trained_model = train_and_save_models( data_module=data_module, fusion_model=ExampleModel )

在这个示例中，prepare_fusion_data 和 train_and_save_models 是项目的核心函数，用于准备数据和训练模型。

3. 项目的配置文件介绍

Fusilli 项目的主要配置文件是 pyproject.toml，它使用 TOML 格式来配置项目的依赖、构建工具等信息。以下是一个示例配置文件的内容：

[project]
name = "fusilli"
version = "1.1.0"
description = "A Python package housing a collection of deep-learning multi-modal data fusion method pipelines"
authors = [
    { name="Florence Townend", email="florence.townend@example.com" },
    { name="Patrick J. Roddy", email="patrick.roddy@example.com" },
    { name="Philipp Goebl", email="philipp.goebl@example.com" }
]
license = { text = "AGPL-3.0" }

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

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

[tool.pytest.ini_options]
addopts = "--cov=fusilli --cov-report=html"

配置文件介绍

[project]: 定义项目的基本信息，如项目名称、版本、描述、作者和许可证。
[build-system]: 指定构建系统所需的依赖和构建后端。
[tool.setuptools]: 配置 setuptools 工具，指定要包含的包。
[tool.pytest.ini_options]: 配置 pytest 工具的选项，例如添加覆盖率报告。

通过这些配置文件，你可以轻松管理项目的依赖、构建和测试环境。

今天的文章 Fusilli 开源项目使用教程分享到此就结束了，感谢您的阅读。

Fusilli 开源项目使用教程