Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert resources into static site #5

Merged
merged 3 commits into from Sep 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 37 additions & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1,37 @@
### Content Structure

As we have used markdown for majority of notes, I think keeping our notes in markdown is a good idea for now. We have six categories that we will be putting our resources into. You can find those categories below and the corrosponding resources:

```bash
├── [ 4.0K] ai/
│ ├── [ 206] _index.en.md
│ ├── [ 3.3K] milestone-roadmap.md
│ ├── [ 2.5K] model-card.md
│ └── [ 2.2K] traps.md
├── [ 4.0K] community/
│ ├── [ 214] _index.en.md
│ └── [ 2.8K] reading-list.md
├── [ 4.0K] legal/
│ ├── [ 2.3K] cla.en.md
│ └── [ 169] _index.en.md
├── [ 4.0K] outreach/
│ └── [ 201] _index.en.md
├── [ 4.0K] product-management/
│ ├── [ 186] _index.en.md
│ └── [ 3.4K] preliminary-interview-template.en.md
└── [ 4.0K] tooling/
└── [ 189] _index.en.md
```

### Creating new resources

If you wish to create a new resource under a category. Simply create a new markdown file containing the info you wish to have in the resource. Make sure you prepend a header describing the resource as below:

```markdown
---
title: "Title of the Resource"
date: 2019-09-03T11:02:05+06:00 # this is the date of the post
type: "post"
---
Rest of the resource goes here
```
3 changes: 3 additions & 0 deletions .gitmodules
@@ -0,0 +1,3 @@
[submodule "quickstart/themes/dot-hugo-documentation-theme"]
path = quickstart/themes/dot-hugo-documentation-theme
url = git@github.com:themefisher/dot-hugo-documentation-theme.git
6 changes: 6 additions & 0 deletions archetypes/default.md
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

124 changes: 124 additions & 0 deletions config.toml
@@ -0,0 +1,124 @@
baseURL = "https://librecorps.github.io/resources/"
theme = "dot-hugo-documentation-theme"
publishDir = "docs"
defaultContentLanguage = "en"
home = "/"

[params]
primaryColor = "#02007e"
secondaryColor = "#f9f9f9"
textColor = "#636363"
textColorDark = "#242738"
whiteColor = "#ffffff"

[Languages]

# English Language
[Languages.en]
languageName = "En"
weight = 1
languageCode = "en"
title = "LibreCorps Resources"
dateFormat = "2 January 2006"
home = "Home"
logo = "LibreCorps"
copyright = "TODO: Put license information here"

# navigation
[Languages.en.menu]

[[Languages.en.menu.main]]
weight = 2
name = "Faq"
url = "faq"

[[Languages.en.menu.main]]
weight = 2
name = "contact"
url = "contact"

[[Languages.en.menu.main]]
weight = 2
name = "pages"
url = "pages"
hasChildren = true

[[Languages.en.menu.main]]
parent = "pages"
name = "Community Strategy"
url = "community"
weight = 2

[[Languages.en.menu.main]]
parent = "pages"
name = "FOSS Product Management"
url = "product-management"
weight = 3

[[Languages.en.menu.main]]
parent = "pages"
name = "AI Ethics & Transparency"
url = "ai"
weight = 4

[[Languages.en.menu.main]]
parent = "pages"
name = "Tooling & Automation"
url = "tooling"
weight = 5

[[Languages.en.menu.main]]
parent = "pages"
name = "Outreach & Marketing"
url = "outreach"
weight = 6

[[Languages.en.menu.main]]
parent = "pages"
name = "Legal"
url = "legal"
weight = 7




# banner
[Languages.en.params.banner]
title = "LibreCorps Knowledge Base"
description = "Here you can find a comprehensive database of resources related to the LibreCorps program"
image = "images/banner.jpg"
placeholder = "Have a question? Just ask here or enter terms"

# Topics
[Languages.en.params.topics]
title = "Find your answer by subject"

# call to action
[Languages.en.params.cta]
enable = true
title = "Didn't find an answer to your question?"
description = "Musce libero nunc, dignissim quis turpis quis, semper vehicula dolor. Suspendisse tincidunt consequat quam."
btnText = "contact us"
btnURL = "contact"

# contact
[Languages.en.params.contact]
title = "Got Any Questions"
content = "Submit the form and confirm your email address at <a class='text-primary' href='https://formspree.io/'>Formspree</a> Then add the following lines to contact page YAML Front Matter."

# footer social icon
[[Languages.en.socialIcon]]
icon = "ti-facebook"
linkURL = "#"

[[Languages.en.socialIcon]]
icon = "ti-twitter-alt"
linkURL = "#"

[[Languages.en.socialIcon]]
icon = "ti-vimeo-alt"
linkURL = "#"

[[Languages.en.socialIcon]]
icon = "ti-instagram"
linkURL = "#"
7 changes: 7 additions & 0 deletions content/ai/_index.en.md
@@ -0,0 +1,7 @@
---
title: "AI Ethics & Transparency"
date: 2018-12-28T11:02:05+06:00
icon: "ti-eye"
description: "Begin developing a more ethical, transparent, and safe AI system with these resources."
type : "pages"
---
48 changes: 48 additions & 0 deletions content/ai/milestone-roadmap.md
@@ -0,0 +1,48 @@
---
title: "AI Ethics & Transparency Roadmap Template"
date: 2019-09-03T11:02:05+06:00
type: "post"
weight : 2
---
## **Team Name** AI Transparency Roadmap

**Executive Summary**

This is your at a glance version of the document. Details and resources attached

* Milestone 1 - **Understanding the Data Flow**
* Data Ecosystem Map - Open Ticket
* Information Sharing Protocol - Open Ticket
* Milestone 2 - **Understanding the Algorithm**
* Dataset Structure - Open Ticket
* Common Traps Mitigations - Open Ticket
* Milestone 3 - **Sharing the Model**
* Model Card Created - Open Ticket

Understanding Data Flow

* Primary Goal: Create documentation that ensures you know what data you&#39;re using and how you plan on sharing it.

This first milestone is about initially understanding the underlying data powering your model. This is generally important for understanding the plumbing and getting an idea about privacy and implications that may arise from sharing data.

**Outcomes:**

* [**Data Ecosystem Map**](https://docs.google.com/document/d/18Zg2JwUDJajVDX5VU0vMijL-c9yfumeAUYDc7rgC4iQ/edit#) **:** This is to document where their data is coming from, what&#39;s using it, stakeholders, etc. The benefit here is not just helping organize how data collection will work in production but also projecting partnerships which may need to be formed in the future.
* [**Information Sharing Protocol**](https://docs.google.com/document/d/1MISHbWU7KGo4Z4AR-b222f6uXrtpQ-GJiJemGYoL--E/edit#) **:** This document is all about conducting an initial assessment of the sensitivity of information you are collecting, who you want to share it with, and how. It&#39;s fairly well thought out but is worth a review and potentially some edits. If you are in the EU, it might just be better to do a[Data Protection Impact Assessment](https://ico.org.uk/for-organisations/guide-to-data-protection/guide-to-the-general-data-protection-regulation-gdpr/data-protection-impact-assessments-dpias/what-is-a-dpia/)

Understanding the Algorithm

* Primary Goal: Create documentation to ensure your whole team understand exactly how your model will be working. A large part of this will be determining the method of managing your datasets as they evolve over the development of the program.

**Outcomes:**

* [**Determine Dataset Structure**](https://humanitarian.atlassian.net/wiki/spaces/imtoolbox/pages/61734950/File+and+Dataset+Management): As you create new data sets, update them, and remove old datasets, you should follow an easy to follow protocol for keeping track of your various data sets as they&#39;re updated and deprecated.
* [**Common Traps When Building Models**](https://drive.google.com/open?id=10Bun6ucDUbTu7ALvoL_Ul0VhTSwJqkaq1zSJ7dvGRls): Review the following traps and document potential risks of your application falling into any of these traps.

Documenting the Algorithm

* Primary Goal: Produce documentation that should be shared with the model.

**Outcomes:**

* [**Document Machine Learning Model Card**](https://drive.google.com/open?id=1n9GhLGqhNCKuQei2RJfgTcUJroZVW8A3eYsS4eY_xFw) **:** Before you release or begin production use of your machine learning model, you can use the linked template to comprehensively document the effects, background, and purpose of your model. This will serve as a core document showing how the model makes the decision it does.
78 changes: 78 additions & 0 deletions content/ai/model-card.md
@@ -0,0 +1,78 @@
---
title: "Machine Learning Model Card"
date: 2019-09-03T11:02:05+06:00
type: "post"
weight : 2
---
## **Model Title**

_The following is simply an editable version of the model card proposed in_ [_https://arxiv.org/abs/1810.03993_](https://arxiv.org/abs/1810.03993)

_Model Details._

Basic information about the model.

- Person or organization developing model
- Date of last update
- Model version
- Model type (Information about training algorithms, parameters, fairness constraints or other applied approaches, and features)
- Paper or other resource for more information
- Citation details
- License
- Maintainer contact details

_Intended Use_

Use cases that were envisioned during development.

- Primary intended uses
- Primary intended users
- Out-of-scope use cases

_Factors_

Factors could include demographic or phenotypic groups, environmental conditions, technical attributes, or others.

- Relevant factors
- Evaluation factors

_Metrics_

Metrics should be chosen to reflect potential real-world impacts of the model.

- Model performance measures
- Decision thresholds
- Variation approaches

_Evaluation Data_

Details on the dataset(s) used for the quantitative analyses in the card.

- Datasets
- Motivation
- Preprocessing

_Training Data._

May not be possible to provide in practice. When possible, this section should mirror Evaluation Data. If such detail is not possible, minimal allowable information should be provided here, such as details of the distribution over various factors in the training datasets.

_Quantitative Analyses_

Quantitative analyses should be broken down by the chosen factors.

- Unitary results
- Intersectional results

_Ethical Considerations_

In this section, you should explore and document the following:

- **Sensitive Data** _: Does the model use any sensitive data (e.g., protected classes)?_
- **Human life** _: Is the model intended to inform decisions about matters central to human life or flourishing – e.g., health or safety? Or could it be used in such a way?_
- **Mitigations** _: What risk mitigation strategies were used during model development?_
- **Risks and harms** _: What risks may be present in model usage? Try to identify the potential recipients, likelihood, and magnitude of harms. If these cannot be determined, note that they were considered but remain unknown._
- **Use cases** _: Are there any known model use cases that are especially fraught?_

_Caveats and Recommendations_

This section should list additional concerns that were not covered in the previous sections.
46 changes: 46 additions & 0 deletions content/ai/traps.md
@@ -0,0 +1,46 @@
---
title: "Common Traps When Building AI Systems"
date: 2019-09-03T11:02:05+06:00
type: "post"
weight : 2
---
## **Avoiding Common ML Traps**

_Assessing common mistakes that lead to unintended side effects._

**The Framing Trap**

_Failure to model the entire system over which a social criterion, such as fairness, will be enforced._

For this trap, we will want to look at our outcome variables. Are these variables a proxy of the actual outcome you wish to achieve? What evidence of existing negative bias currently exists with regards to these variables?

**The Portability Trap**

_Failure to understand how repurposing algorithmic solutions designed for one social context_

_may be misleading, inaccurate, or otherwise do harm when applied to a different context_

Here, you will want to be fully understanding of the context in which this model is being built for and the context in which you will be using it. There should be clear documentation distributed across the entire team focusing on this. What stakeholders do you expect to have an impact on where this technology will be used. Are they informed?

**The Formalism Trap**

_Failure to account for the full meaning of social concepts such as fairness, which can be_

_procedural, contextual, and contestable, and cannot be resolved through mathematical formalisms_

How does your chosen outcome continue to implement and solve existing procedural &quot;catches&quot; in order to ensure the decision making process is fair? What method of recourse are available for those who are unfairly judged?

**The Ripple Effect Trap**

_Failure to understand how the insertion of technology into an existing social system_

_changes the behaviors and embedded values of the pre-existing system_

How do you think the introduction of this recommendation system will affect your users? What changes in behavior do you intend to change? Can you think of any possible changes in behavior that you don&#39;t intend as a result of your software?

**The Solutionism Trap**

_Failure to recognize the possibility that the best solution to a problem may not involve technology_

Will this technology elevate social values which can be quantified? Will it devalue those which cannot? What values might take a back seat if this technology is implemented?

7 changes: 7 additions & 0 deletions content/community/_index.en.md
@@ -0,0 +1,7 @@
---
title: "Community Strategy"
date: 2018-12-28T11:02:05+06:00
icon: "ti-world"
description: "Using these resources, you can build a comprehensive plan towards developing a community strategy."
type : "pages"
---