Skip to content
This repository has been archived by the owner on Oct 31, 2023. It is now read-only.

fix(docs): Corrects typos in README and parameter descriptions #302

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ To explain how it works in different train modes, we call the input of a particu
* **Use case:** learning a mapping from an object to a set of objects of which it is a part, e.g. sentence (from within document) to document.
* trainMode = 3:
* Each example contains a collection of labels. At training time, two labels from the collection are randomly picked as the LHS and RHS.
* **Use case:** learn pairwise similarity from collections of similar objects, e.g. sentence similiarity.
* **Use case:** learn pairwise similarity from collections of similar objects, e.g. sentence similarity.
* trainMode = 4:
* Each example contains two labels. At training time, the first label from the collection will be picked as the LHS and the second label will be picked as the RHS.
* **Use case:** learning from multi-relational graphs.
Expand Down Expand Up @@ -291,8 +291,8 @@ and achieved 96.40% accuracy on an average of 5 runs.
-model model file path

The following arguments for the dictionary are optional:
-minCount minimal number of word occurences [1]
-minCountLabel minimal number of label occurences [1]
-minCount minimal number of word occurrences [1]
-minCountLabel minimal number of label occurrences [1]
-ngrams max length of word ngram [1]
-bucket number of buckets [2000000]
-label labels prefix [__label__]. See file format section.
Expand Down
4 changes: 2 additions & 2 deletions src/utils/args.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,8 @@ void Args::printHelp() {
<< " -testFile test file path\n"
<< " -model model file path\n\n"
<< "The following arguments for the dictionary are optional:\n"
<< " -minCount minimal number of word occurences [" << minCount << "]\n"
<< " -minCountLabel minimal number of label occurences [" << minCountLabel << "]\n"
<< " -minCount minimal number of word occurrences [" << minCount << "]\n"
<< " -minCountLabel minimal number of label occurrences [" << minCountLabel << "]\n"
<< " -ngrams max length of word ngram [" << ngrams << "]\n"
<< " -bucket number of buckets [" << bucket << "]\n"
<< " -label labels prefix [" << label << "]\n"
Expand Down