pingpingy1/hopre

Homophone-based Pun Recognition

hopre's Issues

[Feat] Add code formatter, type checker

Is your feature request related to a problem? Please describe.
As evidenced by this year's projects, different people and even the same person could be highly inconsistent in their coding style.
As such, adding a code linter for both Python and Prolog could lead to a more managable project.
Moreover, by enforcing the Mypy type checking for Python, much unneccessary time and effort could be saved from debugging simple errors.

Describe the solution you'd like
Using Github Action, I'd like to use:

• Black formatter for Python
• Lint action to enforce Mypy checks
• Prolog code formatter (and possibly some type of sanitizer) (TBD)

Describe alternatives you've considered
It would also be beneficial to enforce such actions on the code editor like VSCode.
I should also look for extensions there.

Additional context

[Study] Status-quo of computational models of humor

What kind of question/problem you are aiming
What kinds of computational models of humor have been researched in past years?
How are they designed, implemented, and evaluated?
What could I improve on the current state of the field?

Describe the neccesity of this knowledge
Even after the scope of this project will have been determined, building a recognizer for such pun is still a non-trivial task, and could not be done with my knowledge alone.
Thus, I must learn how other models have been built.
Moreover, the evaluation of a pun-recognition seems highly subjective, so a valid evaluation metric must somehow address this issue.

Additional context

[Study] Linguistic definition of humor and pun

What kind of question/problem you are aiming
What is the linguistic definition of humor and pun?
How does pun differ from satire or wordplay?

Describe the neccesity of this knowledge
This definition is crucial in determining the scope of this project and the evaluation metrics.
It also will hint at how the actual pun-checking engine will be implemented.

Additional context

[Feat] Design Project Architecture

Is your feature request related to a problem? Please describe.
I should decide on the following things:

• What kind of computational jobs are required?
• Should I use Python or Prolog for each part?
• How would the data flow between each module occur?
• What non-computational functionalities are required? eg) User interaction

Describe the solution you'd like
The resulting architecture must be modular, concise, and generalizable.
For example, transitions from hard-coded phonetic similarity to IPA to vector DB should be smooth.
Each module should have a well-defined, simple task that have little overlap.
By looking at the architecture, the prototype should seem within reach.
This should also lead to some loose (preferably tight) definition of the scope of functionalities.

Describe alternatives you've considered
A totally-Python or totally-Prolog is impractical since a friendly interface as well as logical inferences are required.
It may be beneficial to use some diagram-drawing software for this task. eg) Miro

Additional context

[Feat] Redefine project scope

Is your feature request related to a problem? Please describe.
The previous definition of this project's scope relied heavily on the grammatical imperfection of the puns, while in reality, such imperfections are supplementary at best and nonexistent at worst for most of the jokes.
As such, a new definition is required for this project.

Describe the solution you'd like
The goals for this project should be determined not with the features of the homophone-based puns, but rather it should encompass some fragment of each and every feature.
For example, while allowing the sentence to be grammatically correct, limiting the grammatical complexity of the sentence would be a better option than the status quo.

Describe alternatives you've considered

Additional context

[Feat] Define scope of this project

Is your feature request related to a problem? Please describe.
We need an exact definition of the scope for this project, e.g. using some benchmarks and a metric of success.

Describe the solution you'd like
By focusing on a few benchmarks, we could determine how big a fragment of English is actually needed for this project.
As time is highly limited, this step is crucial for a more efficient development management.

Describe alternatives you've considered

Additional context