Merge pull request #28 from pharo-ai/follow-naming-conventions

Follow naming conventions

Author: jecisc

.smalltalk.ston

@@ -2,14 +2,13 @@
 SmalltalkCISpec {
   #loading : [
     SCIMetacelloLoadSpec {
-      #baseline : 'NgramModel',
-      #directory : 'src',
-      #platforms : [ #pharo ]
+      #baseline : 'AINgramModel',
+      #directory : 'src'
     }
   ],
   #testing : {
     #coverage : {
-      #packages : [ 'NgramModel*' ]
+      #packages : [ 'AI-NgramModel*' ]
     }
   }
 }

README.md

@@ -13,7 +13,7 @@ To install the packages of NgramModel, go to the Playground (Ctrl+OW) in your Ph
 
 ```Smalltalk
 Metacello new
-  baseline: 'NgramModel';
+  baseline: 'AINgramModel';
   repository: 'github://pharo-ai/NgramModel/src';
   load
 ```
@@ -72,7 +72,7 @@ This package provides only one class - `Ngram`. It models the n-gram.
 You can create n-gram from any `SequenceableCollection`:
 
 ```Smalltalk
-trigram := Ngram withElements: #(do not like).
+trigram := AINgram withElements: #(do not like).
 tetragram := #(green eggs and ham) asNgram.
 ```
 
@@ -82,13 +82,13 @@ Or by explicitly providing the history (n-gram of lower order) and last element:
 hist := #(green eggs and) asNgram.
 w := 'ham'.
 
-ngram := Ngram withHistory: hist last: w.
+ngram := AINgram withHistory: hist last: w.
 ```
 
 You can also create a zerogram - n-gram of order 0. It is an empty sequence with no history and no last word:
 
 ```Smalltalk
-Ngram zerogram.
+AINgram zerogram.
 ```
 
 ### Accessing
@@ -115,13 +115,13 @@ brown := file contents.
 ```
 #### 2. Training a 2-gram language model on the corpus
 ```Smalltalk
-model := NgramModel order: 2.
+model := AINgramModel order: 2.
 model trainOn: brown.
 ```
 #### 3. Generating text of 100 words
 At each step the model selects top 5 words that are most likely to follow the previous words and returns the random word from those five (this randomnes ensures that the generator does not get stuck in a cycle).
 ```Smalltalk
-generator := NgramTextGenerator new model: model.
+generator := AINgramTextGenerator new model: model.
 generator generateTextOfSize: 100.
 ```
 ## Result:

…NgramSequenceableCollectionTest.class.st …NgramSequenceableCollectionTest.class.stsrc/Ngram-Tests/NgramSequenceableCollectionTest.class.st renamed to src/AI-Ngram-Tests/AINgramSequenceableCollectionTest.class.st src/Ngram-Tests/NgramSequenceableCollectionTest.class.st renamed to src/AI-Ngram-Tests/AINgramSequenceableCollectionTest.class.st

@@ -1,29 +1,26 @@
 Class {
-	#name : #NgramSequenceableCollectionTest,
+	#name : #AINgramSequenceableCollectionTest,
 	#superclass : #TestCase,
-	#instVars : [
-		'collection'
-	],
-	#category : #'Ngram-Tests'
+	#category : #'AI-Ngram-Tests'
 }
 
-{ #category : #running }
-NgramSequenceableCollectionTest >> setUp [ 
-	super setUp.
-	collection := #(I do not like green eggs and ham).
+{ #category : #accessing }
+AINgramSequenceableCollectionTest >> collection [
+
+	^ #( I do not like green eggs and ham )
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testAsNgram [
+AINgramSequenceableCollectionTest >> testAsNgram [
 	| ngram |
-	ngram := collection asNgram.
+	ngram := self collection asNgram.
 	self assert: ngram order equals: 8.
 	self assert: ngram history equals: #(I do not like green eggs and) asNgram.
 	self assert: ngram last equals: 'ham'.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testBigrams [
+AINgramSequenceableCollectionTest >> testBigrams [
 	| expected actual |
 
 	expected := {
@@ -35,12 +32,12 @@ NgramSequenceableCollectionTest >> testBigrams [
 		#(eggs and) asNgram .
 		#(and ham) asNgram }.
 
-	actual := collection bigrams.
+	actual := self collection bigrams.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testBigramsPadWith [
+AINgramSequenceableCollectionTest >> testBigramsPadWith [
 	| expected actual |
 
 	expected := {
@@ -54,12 +51,12 @@ NgramSequenceableCollectionTest >> testBigramsPadWith [
 		#(and ham) asNgram .
 		#(ham '##') asNgram }.
 
-	actual := collection bigramsPadWith: '##'.
+	actual := self collection bigramsPadWith: '##'.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testBigramsWithDefaultPadding [
+AINgramSequenceableCollectionTest >> testBigramsWithDefaultPadding [
 	| expected actual |
 
 	expected := {
@@ -73,12 +70,12 @@ NgramSequenceableCollectionTest >> testBigramsWithDefaultPadding [
 		#(and ham) asNgram .
 		#(ham '<s>') asNgram }.
 
-	actual := collection bigramsWithDefaultPadding.
+	actual := self collection bigramsWithDefaultPadding.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testNgrams [
+AINgramSequenceableCollectionTest >> testNgrams [
 	| expected actual |
 
 	expected := {
@@ -89,12 +86,12 @@ NgramSequenceableCollectionTest >> testNgrams [
 		#(green eggs and) asNgram .
 		#(eggs and ham) asNgram }.
 
-	actual := collection ngrams: 3.
+	actual := self collection ngrams: 3.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testNgramsPadWith [
+AINgramSequenceableCollectionTest >> testNgramsPadWith [
 	| expected actual |
 
 	expected := {
@@ -109,12 +106,12 @@ NgramSequenceableCollectionTest >> testNgramsPadWith [
 		#(and ham '##') asNgram .
 		#(ham '##' '##') asNgram }.
 
-	actual := collection ngrams: 3 padWith: '##'.
+	actual := self collection ngrams: 3 padWith: '##'.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testNgramsWithDefaultPadding [
+AINgramSequenceableCollectionTest >> testNgramsWithDefaultPadding [
 	| expected actual |
 
 	expected := {
@@ -129,12 +126,12 @@ NgramSequenceableCollectionTest >> testNgramsWithDefaultPadding [
 		#(and ham '<s>') asNgram .
 		#(ham '<s>' '<s>') asNgram }.
 
-	actual := collection ngramsWithDefaultPadding: 3.
+	actual := self collection ngramsWithDefaultPadding: 3.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testPentagrams [
+AINgramSequenceableCollectionTest >> testPentagrams [
 	| expected actual |
 
 	expected := {
@@ -143,12 +140,12 @@ NgramSequenceableCollectionTest >> testPentagrams [
 		#(not like green eggs and) asNgram .
 		#(like green eggs and ham) asNgram }.
 
-	actual := collection pentagrams.
+	actual := self collection pentagrams.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testPentagramsPadWith [
+AINgramSequenceableCollectionTest >> testPentagramsPadWith [
 	| expected actual |
 
 	expected := {
@@ -165,12 +162,12 @@ NgramSequenceableCollectionTest >> testPentagramsPadWith [
 		#(and ham '##' '##' '##') asNgram .
 		#(ham '##' '##' '##' '##') asNgram }.
 
-	actual := collection pentagramsPadWith: '##'.
+	actual := self collection pentagramsPadWith: '##'.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testPentagramsWithDefaultPadding [
+AINgramSequenceableCollectionTest >> testPentagramsWithDefaultPadding [
 	| expected actual |
 
 	expected := {
@@ -187,12 +184,12 @@ NgramSequenceableCollectionTest >> testPentagramsWithDefaultPadding [
 		#(and ham '<s>' '<s>' '<s>') asNgram .
 		#(ham '<s>' '<s>' '<s>' '<s>') asNgram }.
 
-	actual := collection pentagramsWithDefaultPadding.
+	actual := self collection pentagramsWithDefaultPadding.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testTetragrams [
+AINgramSequenceableCollectionTest >> testTetragrams [
 	| expected actual |
 
 	expected := {
@@ -202,12 +199,12 @@ NgramSequenceableCollectionTest >> testTetragrams [
 		#(like green eggs and) asNgram .
 		#(green eggs and ham) asNgram }.
 
-	actual := collection tetragrams.
+	actual := self collection tetragrams.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testTetragramsPadWith [
+AINgramSequenceableCollectionTest >> testTetragramsPadWith [
 	| expected actual |
 
 	expected := {
@@ -223,12 +220,12 @@ NgramSequenceableCollectionTest >> testTetragramsPadWith [
 		#(and ham '##' '##') asNgram .
 		#(ham '##' '##' '##') asNgram }.
 
-	actual := collection tetragramsPadWith: '##'.
+	actual := self collection tetragramsPadWith: '##'.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testTetragramsWithDefaultPadding [
+AINgramSequenceableCollectionTest >> testTetragramsWithDefaultPadding [
 	| expected actual |
 
 	expected := {
@@ -244,12 +241,12 @@ NgramSequenceableCollectionTest >> testTetragramsWithDefaultPadding [
 		#(and ham '<s>' '<s>') asNgram .
 		#(ham '<s>' '<s>' '<s>') asNgram }.
 
-	actual := collection tetragramsWithDefaultPadding.
+	actual := self collection tetragramsWithDefaultPadding.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testTrigrams [
+AINgramSequenceableCollectionTest >> testTrigrams [
 	| expected actual |
 
 	expected := {
@@ -260,12 +257,12 @@ NgramSequenceableCollectionTest >> testTrigrams [
 		#(green eggs and) asNgram .
 		#(eggs and ham) asNgram }.
 
-	actual := collection trigrams.
+	actual := self collection trigrams.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testTrigramsPadWith [
+AINgramSequenceableCollectionTest >> testTrigramsPadWith [
 	| expected actual |
 
 	expected := {
@@ -280,12 +277,12 @@ NgramSequenceableCollectionTest >> testTrigramsPadWith [
 		#(and ham '##') asNgram .
 		#(ham '##' '##') asNgram }.
 
-	actual := collection trigramsPadWith: '##'.
+	actual := self collection trigramsPadWith: '##'.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testTrigramsWithDefaultPadding [
+AINgramSequenceableCollectionTest >> testTrigramsWithDefaultPadding [
 	| expected actual |
 
 	expected := {
@@ -300,12 +297,12 @@ NgramSequenceableCollectionTest >> testTrigramsWithDefaultPadding [
 		#(and ham '<s>') asNgram .
 		#(ham '<s>' '<s>') asNgram }.
 
-	actual := collection trigramsWithDefaultPadding.
+	actual := self collection trigramsWithDefaultPadding.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testUnigrams [
+AINgramSequenceableCollectionTest >> testUnigrams [
 	| expected actual |
 
 	expected := {
@@ -318,12 +315,12 @@ NgramSequenceableCollectionTest >> testUnigrams [
 		#(and) asNgram .
 		#(ham) asNgram }.
 
-	actual := collection unigrams.
+	actual := self collection unigrams.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testUnigramsPadWith [
+AINgramSequenceableCollectionTest >> testUnigramsPadWith [
 	| expected actual |
 
 	expected := {
@@ -336,12 +333,12 @@ NgramSequenceableCollectionTest >> testUnigramsPadWith [
 		#(and) asNgram .
 		#(ham) asNgram }.
 
-	actual := collection unigramsPadWith: '##'.
+	actual := self collection unigramsPadWith: '##'.
 	self assert: actual equals: expected.
 ]
 
 { #category : #tests }
-NgramSequenceableCollectionTest >> testUnigramsWithDefaultPadding [
+AINgramSequenceableCollectionTest >> testUnigramsWithDefaultPadding [
 	| expected actual |
 
 	expected := {
@@ -354,6 +351,6 @@ NgramSequenceableCollectionTest >> testUnigramsWithDefaultPadding [
 		#(and) asNgram .
 		#(ham) asNgram }.
 
-	actual := collection unigramsWithDefaultPadding.
+	actual := self collection unigramsWithDefaultPadding.
 	self assert: actual equals: expected.
 ]