search

neulab / ExplainaBoard

Interpretable Evaluation for AI Systems
MIT License
361 stars 36 forks source link

Create the glossary of the technical terms (or ubiquitous languages) in ExplainaBoard #374

Open pfliu-nlp opened 2 years ago

pfliu-nlp commented 2 years ago

(This is suggested by @odashi ) The current documentation mainly lacks things except how-to guides that makes other developers hard to understand how the software is developed.

odashi commented 2 years ago

I'd appreciate if we have follows:

Since the technical term are often used as a class names, it would be better to introduce some constraint of naming rules (e.g., CapitalCase).

Anyway, I will prepare a collaborative document to collect the terms. Once the content of the doc become enough to push, I will propose a pr to this repository.

pfliu-nlp commented 2 years ago

I'd appreciate if we have follows:

  • The definition list of technical terms in doc/glossary.md.
  • Use defined terms everywhere in this repository (discussions, code, and so on)

Since the technical term are often used as a class names, it would be better to introduce some constraint of naming rules (e.g., CapitalCase).

Anyway, I will prepare a collaborative document to collect the terms. Once the content of the doc become enough to push, I will propose a pr to this repository.

Sounds good.