[WIP] component readme updates #536
Conversation
nstsj
commented
Jul 27, 2023
nstsj
commented
- updated I/O on several components + made templates for all the components that had no readmes.
- gonna add I/O info and dependencies info in the upcoming pushes
|
@nstsj merge dev and resolve conflicts. |
| Annotated user input and dialogue context | ||
|
|
||
| **Output** | ||
| A list of selected skills |
There was a problem hiding this comment.
ну если присмотреться к тому, что он выбирает в пайплайне, можно увидеть, ЧТО НЕ СКИЛЛЫ
nstsj
force-pushed
the
key-components-readmes
branch
from
31ecd72
to
def578c
Compare
| @@ -4,8 +4,8 @@ | |||
| Spacy-based user utterance annotator that detects words and phrases from the badlist | |||
|
|
|||
| ## I/O | |||
| input: "sentences": ["fucking hell", "he mishit the shot", "you asshole"], | |||
| output: words and their tags | |||
| **Input:** a list of user's utterances | |||
| [{"bad_words": True}, {"bad_words": False}, {"bad_words": True}] | |||
There was a problem hiding this comment.
where is the title output?
There was a problem hiding this comment.
fixed formatting and examples + fixed ru-version
annotators/COMeT/README.md
Outdated
| - isResponseErroneous | ||
| - isResponseInteresting | ||
| - isResponseOnTopic | ||
| - responseEngagesUser |
There was a problem hiding this comment.
that;'s not about comet
|
|
||
| **Inpunt** | ||
|
|
||
| **Output:** |
There was a problem hiding this comment.
same as Factoid: the info on this one is scarce in our repo, made a ping in our slack channel
| ## Input/Output | ||
|
|
||
| **Input** | ||
| **Output** |
There was a problem hiding this comment.
For this one need to ask someone if/how this one is different from the Factoid clf in combined classification (the info on this one is scarce in our repo).
Pinged in our slack channel.
| ## Input/Output | ||
|
|
||
| **Input** | ||
| **Output** |
There was a problem hiding this comment.
some readmes respawn in their old versions after the branch rebasing(this is a perpetual issue).
Fixed this one as well.
There was a problem hiding this comment.
or this one didn't have any readme previously at all, hmm. Anyway, now it has
| ## Dependencies | ||
| ## Input/Output | ||
| **Input:** a list of hypotheses with their scores and metadata | ||
| **Output:** a list of selected hypotheses with their scores and metadata |
There was a problem hiding this comment.
not a list but the final hypothesis actually
There was a problem hiding this comment.
Fixed to a correct updated version.
| python response_selectors/convers_evaluation_based_selector/measure_quality.py \ | ||
| --data_dir response_selectors/convers_evaluation_based_selector/labeled_data/ \ | ||
| --url http://0.0.0.0:8009/respond | ||
| ``` |
There was a problem hiding this comment.
remove all this info. It is not about local usage.
There was a problem hiding this comment.
i need clarification here: do we want to remove the whole paragraph on "### How to run conversation evaluator locally" or just lines 54-57?
| - the selected skill name, | ||
| - the response text (which can be overwritten) | ||
| - the confidence level |
There was a problem hiding this comment.
better to put an example
|
|
||
| **Input:** | ||
| text here |
There was a problem hiding this comment.
wrong file upd after rebasing, fixed
dilyararimovna
changed the title
…Also added info about I/O to the existing readmes. TBA
nstsj
force-pushed
the
key-components-readmes
branch
from
def578c
to
97956c4
Compare
|
|
||
| An output example: | ||
| ``` | ||
| ``` |
|
|
||
| ``` | ||
|
|
||
| ``` |
| A user's utterance | ||
| ``` | ||
|
|
||
| ``` |
|
|
||
| ``` | ||
| [["Nice to meet you, John."], | ||
| ["text": "john", "type": "PER"]] |
There was a problem hiding this comment.
no. it accepts annotated utterances, including NER.
