fl-documentation
Official documentation of the Federated Learning platform
Science Score: 75.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 2 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
✓Institutional organization owner
Organization dlr-ki has institutional domain (www.dlr.de) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary
Repository
Official documentation of the Federated Learning platform
Basic Info
- Host: GitHub
- Owner: DLR-KI
- Language: Shell
- Default Branch: main
- Homepage: https://dlr-ki.github.io/fl-documentation/
- Size: 982 KB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
- Releases: 2
Metadata Files
README.md
Federated Learning Platform Documentation
This repository contains the official documentation of the Federated Learning platform. The whole documentation is written in markdown and rendered with MkDocs and its material theme.
The Federated Learning (FL) platform is serving as a proof of concept for the Catena-X project. The FL platform aims to demonstrate the potential of federated learning in a practical, real-world context.
A complete list of all repositories relevant to the FL platform can be found here.
Get Started
This README.md is primarily intended for developers and contributors, providing necessary information for setup, installation, and contribution guidelines. If you're interested in using or testing this project, we recommend starting with the GitHub pages which serves this documentation. They offer a more user-friendly interface and comprehensive guides to get you started.
Requirements
- python 3.7 or later
which python - virtualenv or venv
pip install -U virtualenv
Install
```bash
create virtual environment
virtualenv -p $(which python3.7) .venv
or
python -m venv .venv
activate our virtual environment
source .venv/bin/activate
update pip (optional)
python -m pip install -U pip
install
./dev install -U -e ".[all]"
start the server (optional)
./dev start ```
Helpers
```txt
$ ./dev --help
usage: ./dev
positional arguments: {clean,doc,doc-build,help,install,licenses,licenses-check,lint,lint-doc,lint-scripts,safety-check,start,test,version,versions} Available sub commands help Show this help message and exit start Start documentation server test Run all tests lint Run all linter lint-doc Run documentation linter lint-scripts Run bash script linter doc Start documentation server doc-build Build documentation licenses Generate licenses licenses-check Check licenses safety-check Check dependencies for known security vulnerabilities install Install package clean Clean up local files version Show package version versions Show versions ```
Credits
Owner
- Name: DLR Institute of AI Safety and Security
- Login: DLR-KI
- Kind: organization
- Website: https://www.dlr.de/en/ki
- Repositories: 1
- Profile: https://github.com/DLR-KI
Citation (CITATION.cff)
# SPDX-FileCopyrightText: 2024 Benedikt Franke <benedikt.franke@dlr.de>
# SPDX-FileCopyrightText: 2024 Florian Heinrich <florian.heinrich@dlr.de>
#
# SPDX-License-Identifier: Apache-2.0
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: DLR Federated Learning Logging Base
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Florian
family-names: Heinrich
email: florian.heinrich@dlr.de
affiliation: German Aerospace Center (DLR)
orcid: 'https://orcid.org/0009-0007-0792-7908'
- given-names: Benedikt
family-names: Franke
email: benedikt.franke@dlr.de
affiliation: German Aerospace Center (DLR)
orcid: 'https://orcid.org/0000-0003-0202-2804'
- given-names: Unruh
family-names: Johannes
email: johannes.unruh@dlr.de
affiliation: German Aerospace Center (DLR)
orcid: 'https://orcid.org/0009-0003-3214-0331'
- given-names: Tarek
family-names: Stolz
email: tarek.stolz@dlr.de
affiliation: German Aerospace Center (DLR)
orcid: 'https://orcid.org/0009-0000-5735-4318'
- given-names: Martin
family-names: Lanz
email: martin.lanz@dlr.de
affiliation: German Aerospace Center (DLR)
orcid: 'https://orcid.org/0009-0004-5430-5587'
identifiers:
- type: doi
value: 10.5281/zenodo.13951203
repository-code: 'https://github.com/DLR-KI/fl-documentation'
url: 'https://dlr-ki.github.io/fl-documentation/'
keywords:
- Federated Machine Learning
date-released: 2024-07-31
GitHub Events
Total
- Release event: 1
- Push event: 3
- Create event: 1
Last Year
- Release event: 1
- Push event: 3
- Create event: 1
Dependencies
- actions/checkout v4 composite
- actions/deploy-pages v3 composite
- actions/setup-node v4 composite
- actions/setup-python v5 composite
- actions/upload-pages-artifact v2 composite