Spelling

.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@master
-      - name: Git Unshalow
+      - name: Git Unshallow
         run: git fetch --prune --unshallow
       - name: Fetch Node Packages
         run: |

CHANGELOG.md

@@ -14,7 +14,7 @@
 - **nlu-engine:** stop progress watchdog when done or error ([#214](https://github.com/botpress/nlu/issues/214)) ([0661abd](https://github.com/botpress/nlu/commit/0661abd043c22f03381f77561020de64d78b15bc))
 - **nlu-server:** ensure forward slashes in app id wont break fs model repo ([#173](https://github.com/botpress/nlu/issues/173)) ([889aa7c](https://github.com/botpress/nlu/commit/889aa7c447f1647d9da1483d5157fc279d543c63))
 - **nlu-server:** fix send training_time using db config ([6225ef1](https://github.com/botpress/nlu/commit/6225ef124ecc719385afe667f5904885404f6418))
-- no more dupplicated issues in in-mem linting repo ([46cc134](https://github.com/botpress/nlu/commit/46cc13464b4aeaf51289a7f30f1992c377341b47))
+- no more duplicated issues in in-mem linting repo ([46cc134](https://github.com/botpress/nlu/commit/46cc13464b4aeaf51289a7f30f1992c377341b47))
 - **worker:** do not reuse a process if it exited since last usage ([#135](https://github.com/botpress/nlu/issues/135)) ([9c3ab74](https://github.com/botpress/nlu/commit/9c3ab74c1c798fccd5e52e87bda9c4a34ac3d6b2))
 
 ### Features
@@ -141,7 +141,7 @@
 - **lint:** applied linting to code ([774d32c](https://github.com/botpress/nlu/commit/774d32c4f5b414ebd4d22cbd8b4de027feee5f62))
 - **sentry:** use sentry enabled instead of DSN for the configuration ([e89301c](https://github.com/botpress/nlu/commit/e89301cb5d633b6ba9649bb0d9164235885e9308))
 - **style:** fix codestyle for tests, lint & formatting ([c9c572a](https://github.com/botpress/nlu/commit/c9c572a76110c6c54ef8a60bd727ae33e65eb018))
-- **worker:** fix node typings to pass environement variables correctly when spawning new thread ([#76](https://github.com/botpress/nlu/issues/76)) ([853a3f3](https://github.com/botpress/nlu/commit/853a3f3d7de38471cf4539dc395c6bf7b8ee9a27))
+- **worker:** fix node typings to pass environment variables correctly when spawning new thread ([#76](https://github.com/botpress/nlu/issues/76)) ([853a3f3](https://github.com/botpress/nlu/commit/853a3f3d7de38471cf4539dc395c6bf7b8ee9a27))
 - run unit tests of all yarn packages from the root ([26670d3](https://github.com/botpress/nlu/commit/26670d30de797f3fa8c95b55330270157a79f1d1))
 - **style:** fix codestyle for tests, lint & formatting ([cacbf94](https://github.com/botpress/nlu/commit/cacbf948a5f8589ce5bfd6402d3578b48c816497))
 - undefined logger in slot tagger ([b2c688d](https://github.com/botpress/nlu/commit/b2c688dbef69fbda677adc701a23843f47504499))
@@ -157,7 +157,7 @@
 ### Bug Fixes
 
 - exact matcher now works even with different entities ([#56](https://github.com/botpress/nlu/issues/56)) ([6c14b8c](https://github.com/botpress/nlu/commit/6c14b8ce6b14398fcdc621455382c0e18aaa0570))
-- **training:** porgress now won't skip steps ([#55](https://github.com/botpress/nlu/issues/55)) ([4073d61](https://github.com/botpress/nlu/commit/4073d617edf19d683833ee8394ead2376c94fdfa))
+- **training:** progress now won't skip steps ([#55](https://github.com/botpress/nlu/issues/55)) ([4073d61](https://github.com/botpress/nlu/commit/4073d617edf19d683833ee8394ead2376c94fdfa))
 
 ### Features
 
@@ -221,7 +221,7 @@
 - **api:** no need for min 1 context ([e17ae84](https://github.com/botpress/nlu/commit/e17ae84df4d9d1c9d2102ecf3c470547bcf35147))
 - **engine:** spell-checker does not replace entities anymore ([0e0d75a](https://github.com/botpress/nlu/commit/0e0d75a8efa2bb00d9b5c3c08f5873cc66425251))
 - **logger:** no log filter should log all messages ([86e693c](https://github.com/botpress/nlu/commit/86e693c579e5a2a88648dc9810f55821db69b00d))
-- logger attach error no longuer throws ([b84f39a](https://github.com/botpress/nlu/commit/b84f39abd6eea9f8bdd56ec1dbaf5dad5a5e75d4))
+- logger attach error no longer throws ([b84f39a](https://github.com/botpress/nlu/commit/b84f39abd6eea9f8bdd56ec1dbaf5dad5a5e75d4))
 - nanoid is default import from nanoid ([45ca517](https://github.com/botpress/nlu/commit/45ca517250002b230f455049a409867b60cc8836))
 
 ### Features

packages/bitfan/readme.md

@@ -62,7 +62,7 @@ interface Engine<T extends ProblemType> {
 }
 ```
 
-The `Criteria` abstraction act as a decision function that decides weither or not the test is failing or passing. It exists because engines are not responsible for electing a label.
+The `Criteria` abstraction act as a decision function that decides whether or not the test is failing or passing. It exists because engines are not responsible for electing a label.
 
 ```ts
 interface Criteria<T extends ProblemType> {

packages/bitfan/src/bitfan.d.ts

@@ -95,7 +95,7 @@ export namespace sampling {
     dataset: DataSet<T>,
     trainPercent: number,
     seed: number,
-    options?: { stratificate: boolean }
+    options?: { stratify: boolean }
   ) => {
     trainSet: DataSet<T>
     testSet: DataSet<T>
@@ -105,7 +105,7 @@ export namespace sampling {
     dataset: DataSet<T>,
     percent: number,
     seed: number,
-    options?: { stratificate: boolean }
+    options?: { stratify: boolean }
   ) => DataSet<T>
 
   export const sampleClasses: <T extends SingleLabel>(
@@ -132,7 +132,7 @@ export namespace labels {
 }
 
 export namespace tables {
-  export const tabelize: <D>(
+  export const tablize: <D>(
     data: D[],
     disposition: {
       row: (d: D) => string
@@ -249,7 +249,7 @@ export type Prediction<T extends ProblemType> = {
 }
 
 /**
- * @description Function that decides weither or not a test should pass or fail.
+ * @description Function that decides whether or not a test should pass or fail.
  * @returns A number between 0 and 1 where 0 means that the test has failed.
  * For multi-class problems, this number will often be, neither 1 or 0, but a fraction.
  */

packages/bitfan/src/builtin/sampling/samplesClasses.ts

@@ -23,7 +23,7 @@ export const sampleClasses: typeof sdk.sampling.sampleClasses = <T extends sdk.S
     .value()
 
   if (nClass < 0) {
-    throw new Error(`Can't subsample a negative ammount of classes (${nClass}).`)
+    throw new Error(`Can't subsample a negative amount of classes (${nClass}).`)
   }
   if (nClass > allClasses.length) {
     throw new Error(`Can't subsample ${nClass} classes out of ${allClasses.length} class.`)

packages/bitfan/src/builtin/sampling/trainTestSplit.ts

@@ -7,7 +7,7 @@ export const subSample: typeof sampling.subSample = <T extends ProblemType>(
   dataset: DataSet<T>,
   percent: number,
   seed: number,
-  options = { stratificate: true }
+  options = { stratify: true }
 ): DataSet<T> => {
   const { trainSet } = trainTestSplit(dataset, percent, seed, options)
   return trainSet
@@ -17,7 +17,7 @@ export const trainTestSplit: typeof sampling.trainTestSplit = <T extends Problem
   dataset: DataSet<T>,
   trainPercent: number,
   seed: number,
-  options = { stratificate: true }
+  options = { stratify: true }
 ): {
   trainSet: DataSet<T>
   testSet: DataSet<T>
@@ -39,7 +39,7 @@ export const trainTestSplit: typeof sampling.trainTestSplit = <T extends Problem
   const trainSamples: Sample<T>[] = []
   const testSamples: Sample<T>[] = []
 
-  if (options.stratificate) {
+  if (options.stratify) {
     // preserve proportions of each class
     for (const c of allClasses) {
       const samplesOfClass = dataset.samples.filter((r) => areSame(r.label, c))

packages/bitfan/src/builtin/tables/init.test.ts

@@ -1,6 +1,6 @@
 import { initDic } from './init'
 
-test('initDictionnary', () => {
+test('initDictionary', () => {
   // arrange
 
   // act

packages/bitfan/src/builtin/tables/tabelize.test.ts → packages/bitfan/src/builtin/tables/tablize.test.ts

@@ -1,5 +1,5 @@
 import * as sdk from '../../bitfan'
-import { tabelize } from './tabelize'
+import { tablize } from './tablize'
 
 test('toTable', () => {
   // arrange
@@ -14,7 +14,7 @@ test('toTable', () => {
   }
 
   // act
-  const table = tabelize(performanceReport.scores, {
+  const table = tablize(performanceReport.scores, {
     row: (d) => d.metric,
     column: (d) => `${d.seed}`,
     score: (d) => d.score

packages/bitfan/src/builtin/tables/tabelize.ts → packages/bitfan/src/builtin/tables/tablize.ts

@@ -2,7 +2,7 @@ import * as sdk from 'bitfan/sdk'
 import _ from 'lodash'
 import { initTable } from './init'
 
-export const tabelize: typeof sdk.tables.tabelize = <D>(
+export const tablize: typeof sdk.tables.tablize = <D>(
   data: D[],
   disposition: {
     row: (d: D) => string

packages/bitfan/src/builtin/visualisation/report.ts

@@ -2,7 +2,7 @@ import * as sdk from 'bitfan/sdk'
 import chalk from 'chalk'
 import _ from 'lodash'
 import { roundTable } from '../tables/round'
-import { tabelize } from '../tables/tabelize'
+import { tablize } from '../tables/tablize'
 
 const DEFAULT_OPT: {
   groupBy: 'seed' | 'problem' | 'all'
@@ -18,7 +18,7 @@ export const showPerformanceReport: typeof sdk.visualisation.showPerformanceRepo
 ) => {
   const options = { ...DEFAULT_OPT, ...(opt ?? {}) }
 
-  let table = tabelize(report.scores, {
+  let table = tablize(report.scores, {
     row: (s) => s.metric,
     column: (s) => (options.groupBy === 'seed' ? `${s.seed}` : options.groupBy === 'problem' ? s.problem : 'all'),
     score: (s) => s.score

packages/bitfan/src/index.ts

@@ -23,7 +23,7 @@ import { trainTestSplit, subSample } from './builtin/sampling/trainTestSplit'
 import { isAllDefined } from './builtin/tables/guards'
 import { initDic, initTable } from './builtin/tables/init'
 import { roundDic, roundTable } from './builtin/tables/round'
-import { tabelize } from './builtin/tables/tabelize'
+import { tablize } from './builtin/tables/tablize'
 import { transposeTable } from './builtin/tables/transpose'
 import { showClassDistribution, showDatasetsSummary } from './builtin/visualisation/dataset'
 import { showOOSConfusion } from './builtin/visualisation/oos'
@@ -104,7 +104,7 @@ const impl: typeof sdk = {
   },
 
   tables: {
-    tabelize,
+    tablize,
     initDic,
     initTable,
     roundDic,

packages/bitfan/src/services/bp-provider/stan-provider.ts

@@ -65,7 +65,7 @@ export class StanProvider {
   public async predict(utterances: string[]): Promise<PredictOutput[]> {
     const predOutput = await this._client.predict(APP_ID, this._modelId ?? '', { utterances })
     if (!predOutput.success) {
-      throw new Error(`An error occured at prediction: ${predOutput.error.message}.`)
+      throw new Error(`An error occurred at prediction: ${predOutput.error.message}.`)
     }
     return predOutput.predictions
   }

packages/bitfan/src/solution.ts

@@ -42,7 +42,7 @@ const makeSolutionRunner = <T extends sdk.ProblemType>(
       // eslint-disable-next-line no-console
       console.log(
         chalk.red(
-          `The following error occured when solving problem ${problem.name} with seed ${seed}:\n${err.message}\n${err.stack}`
+          `The following error occurred when solving problem ${problem.name} with seed ${seed}:\n${err.message}\n${err.stack}`
         )
       )
       process.exit(1)

packages/distributed/readme.md

@@ -8,12 +8,12 @@ Locks prevent multiple types of race conditions. Race conditions can occur:
 
 - in single-threaded apps when using asynchronous code
 - in multi-threaded/multi-process apps
-- in mutli-instances apps
+- in multi-instances apps
 
 ## Queues
 
 A Distributed Task Queue can run tasks on multiple instances without the need for a master slave configuration.
 
 ## Licensing
 
-This software is protected by the same license as the [main Botpress repository](https://github.com/botpress/botpress). You can find the license file [here](https://github.com/botpress/botpress/blob/master/LICENSE).
+This software is protected by the same [license](https://github.com/botpress/botpress/blob/master/LICENSE) as the [main Botpress repository](https://github.com/botpress/botpress).

packages/distributed/src/locks/in-mem-trx-locker.ts

@@ -2,7 +2,7 @@ import _ from 'lodash'
 import { TransactionLocker, Logger, Transaction } from './typings'
 
 /**
- * For race conditions occuring because of the event loop in a single-threaded application
+ * For race conditions occurring because of the event loop in a single-threaded application
  */
 export class InMemoryTransactionLocker<T> implements TransactionLocker<T> {
   private _tasks: Transaction<void>[] = []

packages/distributed/src/locks/pg-trx-locker.ts

@@ -7,7 +7,7 @@ import { TransactionLocker, Transaction, Logger } from './typings'
 const TRX_LOCK_KEY = 'trx_lock'
 
 /**
- * For race conditions occuring in distributed applications
+ * For race conditions occurring in distributed applications
  */
 export class PGTransactionLocker<T> implements TransactionLocker<T> {
   private client: Client

packages/distributed/src/locks/typings.ts

@@ -7,12 +7,12 @@ export type Transaction<T> = {
  * Prevents race conditions by only running one task at a time.
  * Tasks are simply called when its there turn to run.
  *
- * Does not involve to mannualy check if lock is free.
+ * Does not involve to manually check if lock is free.
  */
 export type TransactionLocker<T> = {
   /**
-   * Waits for a lock to be free, aquires it and runs function
-   * @param t The async function to run inside the aquire and release lock statement
+   * Waits for a lock to be free, acquires it and runs function
+   * @param t The async function to run inside the acquire and release lock statement
    * @returns A promise that resolves of rejects once the task is done or throws
    */
   runInLock(t: Transaction<T>): Promise<T>

packages/distributed/src/queues/base-queue.ts

@@ -76,7 +76,7 @@ export abstract class BaseTaskQueue<TId, TInput, TData, TError> implements ITask
       return this._schedulingTimmer.run()
     } catch (thrown) {
       const err = thrown instanceof Error ? thrown : new Error(`${thrown}`)
-      this._logger.attachError(err).error('An error occured when running scheduler interrupt.')
+      this._logger.attachError(err).error('An error occurred when running scheduler interrupt.')
     }
   }
 
@@ -92,12 +92,12 @@ export abstract class BaseTaskQueue<TId, TInput, TData, TError> implements ITask
         return
       }
 
-      const pendings = await repo.query({ status: 'pending' })
-      if (pendings.length <= 0) {
+      const pending = await repo.query({ status: 'pending' })
+      if (pending.length <= 0) {
         return
       }
 
-      const task = pendings[0]
+      const task = pending[0]
       task.status = 'running'
       task.cluster = this._clusterId
       await repo.set(task)

packages/distributed/src/queues/interrupt.ts

@@ -26,10 +26,10 @@ export type InterruptTimer<X extends any[]> = {
  *
  * Basically the opposite of a throttle.
  * Ensures a function is executed at least every x ms.
- * Running the function mannualy only resets the timmer.
+ * Running the function manually only resets the timmer.
  *
  * @param f Function to run
- * @param ms Max allowed time beetween function invocation
+ * @param ms Max allowed time between function invocation
  * @returns a timer object that can be ran or stopped
  */
 export const createTimer = <X extends any[]>(f: Func<X, Promise<void>>, ms: number): InterruptTimer<X> => {

packages/distributed/src/queues/pg-distributed-queue.ts

@@ -105,7 +105,7 @@ export class PGDistributedTaskQueue<TId, TInput, TData, TError>
 
   private _handleCancelTaskEvent = async (taskId: TId, clusterId: string) => {
     if (clusterId !== this._clusterId) {
-      return // message was not adressed to this instance
+      return // message was not addressed to this instance
     }
 
     try {
@@ -117,7 +117,7 @@ export class PGDistributedTaskQueue<TId, TInput, TData, TError>
     }
   }
 
-  // for if an completly busy instance receives a queue task http call
+  // for if a completely busy instance receives a queue task http call
   protected runSchedulerInterrupt() {
     return this._obs.emit('run_scheduler_interrupt', undefined)
   }