Joshua Lansford commited on
Commit
f1f2dff
·
1 Parent(s): d348741

Added license to readme

Browse files
Files changed (1) hide show
  1. README.md +4 -2
README.md CHANGED
@@ -13,14 +13,14 @@ license: apache-2.0
13
  ## Sentance Transmorgrifier
14
 
15
  # What is the Sentance Transmorgrifier?
16
- - The Sentance Transmorgrifier is a generic text to text conversion tool which uses a categorical gradiant boost library, [catboost](https://catboost.ai/), as its back end.
17
  - This library does not use neural net or word embeddings but does the transformation on the character level.
18
  - For Sentance Transmorgrifier to work, there has to be some common characters between the from and two conversion.
19
  - The model uses a modified form of the [logest common subsequence algorithm](https://en.wikipedia.org/wiki/Longest_common_subsequence_problem) to transform the sentance conversion into a sequence of three types of operations:
20
  1. Match: Pass the character from input to output
21
  2. Drop: Remove the incoming character from the input.
22
  3. Insert: Generate a character and add it to the output.
23
- - The transformation uses a sliding context window of the next n incoming characters, n output transformed chars and n output untransformed chars.
24
  - Because the window is sliding, there is no fixed length on the character sequences which can be transformed.
25
 
26
  # How can I use the Sentance Transmorgrifier
@@ -145,3 +145,5 @@ my_model.load( "my_model.tm" )
145
  #model returns a generator so wrap it with a list
146
  results = list( my_model.execute( inference_data["from_header"] ) )
147
  ```
 
 
 
13
  ## Sentance Transmorgrifier
14
 
15
  # What is the Sentance Transmorgrifier?
16
+ - The Sentance Transmorgrifier is a framework to make text to text conversion models which uses a categorical gradiant boost library, [catboost](https://catboost.ai/), as its back end.
17
  - This library does not use neural net or word embeddings but does the transformation on the character level.
18
  - For Sentance Transmorgrifier to work, there has to be some common characters between the from and two conversion.
19
  - The model uses a modified form of the [logest common subsequence algorithm](https://en.wikipedia.org/wiki/Longest_common_subsequence_problem) to transform the sentance conversion into a sequence of three types of operations:
20
  1. Match: Pass the character from input to output
21
  2. Drop: Remove the incoming character from the input.
22
  3. Insert: Generate a character and add it to the output.
23
+ - The transformation uses a sliding context window of the next n incoming characters, ``n`` output transformed chars and n output untransformed chars.
24
  - Because the window is sliding, there is no fixed length on the character sequences which can be transformed.
25
 
26
  # How can I use the Sentance Transmorgrifier
 
145
  #model returns a generator so wrap it with a list
146
  results = list( my_model.execute( inference_data["from_header"] ) )
147
  ```
148
+ # What is the license?
149
+ - The licence has been set to apache-2.0 to match catboost so I don't have to think about compatibility issues.