Algoritmekader

Het Ministerie van Binnenlandse Zaken en Koninkrijksrelaties ontwikkelt het Algoritmekader op een open manier via Github. Het doel van het Algoritmekader is om overheden op een praktische wijze te ondersteunen, zodat zij op een wettige en ethisch verantwoorde wijze algoritmes en AI-systemen gebruiken.

In deze repository ontwikkelen wij het Algoritmekader. De informatie van het Algoritmekader wordt uitgewerkt in verschillende Markdown bestanden (een bestandsformaat voor platte tekstbestanden), welke je terug kan vinden in de map docs. Deze bestanden worden inzichtelijk gemaakt met behulp van MkDocs en Material for MkDocs.

Het Algoritmekader kun je bekijken op https://minbzk.github.io/Algoritmekader.

Hoe kun je bijdragen?

Dat kan op verschillende manieren. Zie onze Contributing Guidelines voor meer uitleg over hoe je kan bijdragen aan het Algoritmekader.

Lokaal ontwikkelen

Het Algoritmekader project kan lokaal met behulp van Python worden gedraaid. Installeer hiervoor de benodigde packages in een virtual environment:

pip install -r requirements.txt

Als je onderdeel bent van de MinBZK organisatie op GitHub, dan kun je ook de productie versie installeren:

pip install -r requirements-prod.txt

Vervolgens kun je een preview van het Algoritmekader bekijken:

mkdocs serve

Het verschil tussen de twee versies is dat het Algoritmekader gebruik maakt van de insiders versie van Material for MkDocs. De insiders versie is een gesponsorde versie en bevat een aantal extra functionaliteiten. Hoewel deze versie onder een open source licentie beschikbaar is, vragen de ontwikkelaars van Material for MkDocs in de aanvullende fair use policity om het niet publiek te delen. Wij realiseren ons dat hierdoor niet iedereen de versie van het Algoritmekader, inclusief alle functionaliteiten, op een eigen omgeving kan draaien. Om lokaal testen van mensen die geen toegang hebben tot de betaalde versie mogelijk te maken, zit in requirements.txt de publiek toegangelijke mkdocs-material Python package met beperkte functionaliteit. In deze versie werken de navigatie broodkruimels niet.

Vragen?

Maak een Issue aan op GitHub. Of stuur een e-mail naar algoritmes@minbzk.nl.