Skip to content

Commit dd5048f

Browse files
authored
docs: update TypeScript documentation and fix whitespace in nlp/lda declarations
PR-URL: #12730 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 47e2cbf commit dd5048f

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

  • lib/node_modules/@stdlib/nlp/lda/docs/types

lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ interface Options {
2828
alpha?: number;
2929

3030
/**
31-
* Dirichlet hyper-parameter for word vector phi (default: `0.1`).
31+
* Dirichlet hyper-parameter for word vector phi (default: `0.1`).
3232
*/
3333
beta?: number;
3434
}
@@ -76,8 +76,9 @@ interface Model {
7676
* @param documents - document corpus
7777
* @param K - number of topics
7878
* @param options - options object
79-
* @param options.alpha - Dirichlet hyper-parameter of topic vector theta
80-
* @param options.beta - Dirichlet hyper-parameter for word vector phi
79+
* @param options.alpha - Dirichlet hyper-parameter of topic vector theta (default: 50/K)
80+
* @param options.beta - Dirichlet hyper-parameter for word vector phi (default: 0.1)
81+
* @throws first argument must be an array of strings
8182
* @throws second argument must be a positive integer
8283
* @throws must provide valid options
8384
* @returns model object

0 commit comments

Comments
 (0)