ExplainaBoard icon indicating copy to clipboard operation
ExplainaBoard copied to clipboard

Several things are not documented in text classification tutorial

Open neubig opened this issue 3 years ago • 1 comments

I think it would be nice to have a tutorial that is basically the first thing that people look at when they want to figure out how to use ExplainaBoard on their own systems. The text classification tutorial is one good candidate for this, as text classification is a very easy-to-understand task with wide applicability.

However, while it tells you how to run the program and get an output json file, it is not quite useful yet because we need:

  • [ ] An explanation on how to interpret or visualize the file

My ideal solution would be to link it together with something like what will be implemented in this PR (https://github.com/neulab/ExplainaBoard/issues/60) which will be much more interpretable than a static JSON file, but at least an explanation of the JSON file format and what we could glean from it would be useful.

In addition, some basic functionality of ExplainaBoard is not documented, e.g.:

  • [ ] Pairwise analysis
  • [ ] Fine-grained error analysis

It'd be nice to work on this documentation!

neubig avatar Feb 01 '22 11:02 neubig

"My ideal solution would be to link it together with something like what will be implemented in this PR"

Yeah, I have similar solution before I read the above sentence. We need some env where cli and visual platform can interact in a real-time fashion. I have mentioned this example.

pfliu-nlp avatar Feb 01 '22 18:02 pfliu-nlp