Call-for-Code-for-Racial-Justice / Call-for-Code-for-Racial-Justice/TakeTwo-WebAPI
Recommendations API
- Dominant language
- Python
- Stars
- 8
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
### Background on the problem the feature will solve/improved user experience
People who use TakeTwo might not only want to detect racially biased content but receive help on how to debias their content.
### Describe the solution you'd like
A solution that updates the web API to provide recommendations as an endpoint,
Related to : https://github.com/Call-for-Code-for-Racial-Justice/TakeTwo-DataScience/issues/20
### Tasks
### Acceptance Criteria
Standards we believe this issue must reach to be considered complete and ready for a pull request. E.g precisely all the user should be able to do with this update, performance requirements, security requirements, etc as appropriate.
- As a user, if the content I've input for analysis is found to be biased, I receive accurate alternatives that are unbiased to replace them with
- For a given API call, recommendations endpoint is returned as part of "flagged" data object.
Contributor guide
Research direction
Read the existing web API contract and the related DataScience issue #20 first, then trace how the flagged data object is produced. Define the recommendations endpoint and its response with the project maintainers; done means biased input returns accurate unbiased alternatives and the recommendations are included in the flagged object.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100