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

Classify each dictionary item into a difficulty level. #5

Open
3 of 4 tasks
wammar opened this issue May 3, 2024 · 3 comments
Open
3 of 4 tasks

Classify each dictionary item into a difficulty level. #5

wammar opened this issue May 3, 2024 · 3 comments
Assignees

Comments

@wammar
Copy link

wammar commented May 3, 2024

Why is this needed? Our UX research concluded that we want to offer users the option to specify the difficulty level of jargon definitions. In order to do that, we need to systematically label each definition.
 
Subtasks:

  • Decide on a classification system (e.g., low, medium, high).
  • Set thresholds.
  • Evaluation.
  • Implement the API call for it.
@wammar
Copy link
Author

wammar commented May 17, 2024

Acceptance criteria:

  • Add an endpoint definition to the existing OpenAPI file, which takes as input (a term and a definition), and returns a string.
  • Implementation in FastAPI (leveraging the code Jen already wrote).
  • OpenAPI documentation.

@jonjiang1
Copy link

FastAPI documentation and tutorial for setting up a new path/endpoint https://fastapi.tiangolo.com/tutorial/path-params/

jonjiang1 pushed a commit that referenced this issue May 20, 2024
@wammar
Copy link
Author

wammar commented May 24, 2024

@zepam Are you still planning to implement the API interface for this?

Jonathan suggests that the API interface is not required, and we can integrate this module as a subprocess in the simplification module instead. I'm OK either way based on the revised architecture as of May 24.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants