NW.NGramTextClassification.CLI 5.0.0

dotnet tool install --global NW.NGramTextClassification.CLI --version 5.0.0
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local NW.NGramTextClassification.CLI --version 5.0.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=NW.NGramTextClassification.CLI&version=5.0.0
                    
nuke :add-package NW.NGramTextClassification.CLI --version 5.0.0
                    

NW.NGramTextClassification.CLI

NW.NGramTextClassification.CLI is a NuGet tool to perform text classification tasks on the text snippets you provide.

Getting Started

If /home/nw.ngramtextclassification is the folder in which the .nupkg file is located, you can install it and run it using these commands:

dotnet tool install --global NW.NGramTextClassification.CLI --add-source /home/nw.ngramtextclassification
nwngram

CLI Reference

Command Sub Command Options Exit Codes
scaffold --folderpath {path}<br />--enableutc Success<br />Failure
classify --labeledexamples {filename}<br />--textsnippets {filename}<br />--folderpath {path}<br />--tokenizerruleset {filename}<br />--minaccuracysingle {number}<br />--minaccuracymultiple {number}<br />--saveoutput<br />--cleanlabeledexamples<br />--disableindexserialization<br />--enableutc Success<br />Failure

The scaffold command

To get started with this application, you need three files:

  • LabeledExamples.json (required)
  • TextSnippets.json (required)
  • TokenizerRuleSet.json (optional)

The scaffold command creates an example file for each of them in the same folder as the application, which by default it's the working folder for all the application's activities.

At very least, the command will look like:

.\nwngram.exe scaffold

The command above will log something like this to the console:

****************************************************************************
'##::: ##:'##:::::'##:'##::: ##::'######:::'########:::::'###::::'##::::'##:
 ###:: ##: ##:'##: ##: ###:: ##:'##... ##:: ##.... ##:::'## ##::: ###::'###:
 ####: ##: ##: ##: ##: ####: ##: ##:::..::: ##:::: ##::'##:. ##:: ####'####:
 ## ## ##: ##: ##: ##: ## ## ##: ##::'####: ########::'##:::. ##: ## ### ##:
 ##. ####: ##: ##: ##: ##. ####: ##::: ##:: ##.. ##::: #########: ##. #: ##:
 ##:. ###: ##: ##: ##: ##:. ###: ##::: ##:: ##::. ##:: ##.... ##: ##:.:: ##:
 ##::. ##:. ###. ###:: ##::. ##:. ######::: ##:::. ##: ##:::: ##: ##:::: ##:
..::::..:::...::...:::..::::..:::......::::..:::::..::..:::::..::..:::::..::
*********************************************************Version: 5.0.0*****


[2026-11-16 11:31:17:072] The scaffolding process has started.
[2026-11-16 11:31:17:217] The following example JSON file has been created: '/workspaces/LabeledExamples.json'.
[2026-11-16 11:31:17:222] The following example JSON file has been created: '/workspaces/TextSnippets.json'.
[2026-11-16 11:31:17:231] The following example JSON file has been created: '/workspaces/TokenizerRuleSet.json'.
[2026-11-16 11:31:17:231] The scaffolding process has been completed.

If you wish to store the files elsewhere, you can specify a new working folder by using the --folderpath option - i.e. --folderpath:C:\Documents

By default, the application's logger adopts the local time for the timestamps. If you want to enable UTC timestamps instead, you can provide the --enableutc option.

The classify command

Once you scaffolded the required files and added your own data inside, you are ready to perform a text classification task on them by using the classify command.

The command above requires that you have the two required files (LabeledExamples.json and TextSnippets.json) located in the working folder.

At very least, the command will look like:

.\nwngram.exe classify --labeledexamples .\LabeledExamples.json --textsnippets .\TextSnippets.json

The command above will log something like this to the console:

****************************************************************************
'##::: ##:'##:::::'##:'##::: ##::'######:::'########:::::'###::::'##::::'##:
 ###:: ##: ##:'##: ##: ###:: ##:'##... ##:: ##.... ##:::'## ##::: ###::'###:
 ####: ##: ##: ##: ##: ####: ##: ##:::..::: ##:::: ##::'##:. ##:: ####'####:
 ## ## ##: ##: ##: ##: ## ## ##: ##::'####: ########::'##:::. ##: ## ### ##:
 ##. ####: ##: ##: ##: ##. ####: ##::: ##:: ##.. ##::: #########: ##. #: ##:
 ##:. ###: ##: ##: ##: ##:. ###: ##::: ##:: ##::. ##:: ##.... ##: ##:.:: ##:
 ##::. ##:. ###. ###:: ##::. ##:. ######::: ##:::. ##: ##:::: ##: ##:::: ##:
..::::..:::...::...:::..::::..:::......::::..:::::..::..:::::..::..:::::..::
*********************************************************Version: 5.0.0*****


[2026-11-15 19:16:09:545] The text classification process has started.
[2026-11-15 19:16:09:552] The provided 'FolderPath' is: '/workspaces/'.
[2026-11-15 19:16:09:552] The provided 'MinimumAccuracySingleLabel' is: '0.5'.
[2026-11-15 19:16:09:553] The provided 'MinimumAccuracyMultipleLabels' is: '0'.
[2026-11-15 19:16:09:553] The provided 'SaveOutput' is: 'False'.
[2026-11-15 19:16:09:553] The provided 'CleanLabeledExamples' is: 'False'.
[2026-11-15 19:16:09:553] The provided 'DisableIndexSerialization' is: 'False'.
[2026-11-15 19:16:09:553] The provided 'EnableUTC' is: 'False'.
[2026-11-15 19:16:09:553] The provided 'LabeledExamplesFileName' is: 'LabeledExamples.json'.
[2026-11-15 19:16:09:553] The provided 'TextSnippetsFileName' is: 'TextSnippets.json'.
[2026-11-15 19:16:09:696] '2' LabeledExample objects have been loaded.
[2026-11-15 19:16:09:704] '2' TextSnippet objects have been loaded.
[2026-11-15 19:16:09:704] The provided 'NGramTokenizerRuleSet' is: '[ DoForMonogram: 'True', DoForBigram: 'True', DoForTrigram: 'True', DoForFourgram: 'True', DoForFivegram: 'True' ]'.
[2026-11-15 19:16:09:840] The text classification output has been successfully created.
[2026-11-15 19:16:09:840] The text classification output contains the following results:
[2026-11-15 19:16:09:840] [ Text: 'We are looking for several skilled and driven developers to join our team.', Label: 'en' ]
[2026-11-15 19:16:09:840] [ Text: 'Vår kund erbjuder trivsel, arbetsglädje och en trygg arbetsmiljö.', Label: 'sv' ]
[2026-11-15 19:16:09:840] The text classification process has been completed.

If you wish to store the outcome to a handy JSON file, you can use the --saveoutput option and (optionally) the --disableindexserialization option for a shorter output.

.\nwngram.exe classify --labeledexamples .\LabeledExamples.json --textsnippets .\TextSnippets.json --saveoutput --disableindexserialization

The produced JSON will look like:

{
  "MinimumAccuracySingleLabel": 0.5,
  "MinimumAccuracyMultipleLabels": 0,
  "Results": [
    {
      "TextSnippet": {
        "Text": "We are looking for several skilled and driven developers to join our team."
      },
      "Label": "en",
      "SimilarityIndexes": [],
      "SimilarityIndexAverages": [
        {
          "Label": "en",
          "Value": 1
        },
        {
          "Label": "sv",
          "Value": 0
        }
      ]
    },
    {
      "TextSnippet": {
        "Text": "Vår kund erbjuder trivsel, arbetsglädje och en trygg arbetsmiljö."
      },
      "Label": "sv",
      "SimilarityIndexes": [],
      "SimilarityIndexAverages": [
        {
          "Label": "en",
          "Value": 0
        },
        {
          "Label": "sv",
          "Value": 1
        }
      ]
    }
  ],
  "Version": "5.0.0"
}

If your LabeledExamples.json file contains invalid text excerpts, such as:

[
    {
      "Label": "ham",
      "Text": ":)"
    },
    {
      "Label": "ham",
      "Text": ":-) :-)"
    }
  ] 

the log of application will end as following:

...
[2026-11-15 19:19:12:327] '2' LabeledExample objects have been loaded.
[2026-11-15 19:19:12:333] '2' TextSnippet objects have been loaded.
[2026-11-15 19:19:12:333] The provided 'NGramTokenizerRuleSet' is: '[ DoForMonogram: 'True', DoForBigram: 'True', DoForTrigram: 'True', DoForFourgram: 'True', DoForFivegram: 'True' ]'.
[2026-11-15 19:19:12:378] ERROR: The provided ITokenizationStrategy pattern ('[\w0-9_]{1,}') retuns zero matches against the provided text (':)').

All the labeled examples that might prevent the application to run can be ignored by using the --cleanlabeledexamples option:

...
[2026-11-15 19:22:43:162] '2' LabeledExample objects have been loaded.
[2026-11-15 19:22:43:169] '2' TextSnippet objects have been loaded.
[2026-11-15 19:22:43:169] The provided 'NGramTokenizerRuleSet' is: '[ DoForMonogram: 'True', DoForBigram: 'True', DoForTrigram: 'True', DoForFourgram: 'True', DoForFivegram: 'True' ]'.
[2026-11-15 19:22:43:388] The provided LabeledExample objects have been thru the cleaning process. Now they are: '0'.
[2026-11-15 19:22:43:409] ERROR: 'LabeledExamples' contains zero items.

The --cleanlabeledexamples option can also ignore any text excerpts incompatible with your specified --tokenizerruleset (or the default one). When this occurs, the log lists the affected excerpts, so that you can finetune your TokenizerRuleSet.json accordingly:

...
[2026-11-15 21:54:23:565] The provided 'CleanLabeledExamples' is: 'True'.
...
[2026-11-15 21:54:23:737] '5572' LabeledExample objects have been loaded.
[2026-11-15 21:54:23:744] '6' TextSnippet objects have been loaded.
[2026-11-15 21:54:23:754] The provided 'NGramTokenizerRuleSet' is: '[ DoForMonogram: 'True', DoForBigram: 'True', DoForTrigram: 'True', DoForFourgram: 'True', DoForFivegram: 'False' ]'.
[2026-11-15 21:54:26:541] The provided LabeledExample objects have been thru the cleaning process. Now they are: '5450'.
[2026-11-15 21:54:26:541] The following '122' LabeledExamples have been removed:
[2026-11-15 21:54:26:542] Removed: [ Label: 'ham', Text: 'Yup next stop.' ]
[2026-11-15 21:54:26:542] Removed: [ Label: 'ham', Text: 'I'm home.' ]
[2026-11-15 21:54:26:542] Removed: [ Label: 'ham', Text: 'Goodmorning sleeping ga.' ]
...
[2026-11-15 21:54:26:542] The text classification output has been successfully created.
...

Providing the --cleanlabeledexamples option runs the removal process in memory without modifying the LabeledExamples.json file.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last Updated
5.0.0 66 11/16/2026
4.3.0 113 10/26/2026
4.2.1 155 7/19/2026