Skip to content

eScienceLab/federated-learning-ro-crate-profile

Repository files navigation

RO-Crate for Federated Learning

Note: This is a first draft currently in active development.

RO-Crate Profile for Federated Learning

A RO-Crate profile for federated learning is being developed as part of the Fed-A-Crate project within the ELIXIR Human Data and Translational Research programme.

About the profile

See the profile website https://esciencelab.org.uk/federated-learning-ro-crate-profile/.

How to use this repo

The make_crate.py Python script creates an example crate that represents the profile.

To run the scripts you must install the requirements listed in requirements.txt, e.g. pip install -r requirements.txt.

The scripts automatically run validation against the RO-Crate 1.1 specification when generating the RO-Crate. This should tell you if you did anything wrong according to the base spec (but does not mean that all entities are linked correctly).

The script generates an RO-Crate in the fl-crate folder. To generate a HTML preview of the crate (useful for checking things are linked as intended):

npm install ro-crate-html
rochtml fl-crate/ro-crate-metadata.json

The example-fl-crate folder contains the example RO-Crate hosted on the website. This can be manually updated as required by copying from fl-crate (the folders are separated to prevent accidentally updating the live example while working on changes to the make_crate.py script).

Where to find useful metadata and identifiers

Licensing

Profile Crates and JSON-LD examples within this specification are distributed under CC0 1.0 Universal (CC0 1.0) Public Domain Dedication.

Other files, including the specification text and helper scripts, are licensed under the Apache License, Version 2.0.

About

An RO-Crate profile for Federated Learning

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published