Skip to content

Commit

Permalink
docs - fix use of brackets in itemize items
Browse files Browse the repository at this point in the history
  • Loading branch information
jwijffels committed Feb 19, 2024
1 parent 0430c5e commit 93fbe80
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 8 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: ruimtehol
Type: Package
Title: Learn Text 'Embeddings' with 'Starspace'
Version: 0.3.1
Version: 0.3.2
Maintainer: Jan Wijffels <[email protected]>
Authors@R: c(
person('Jan', 'Wijffels', role = c('aut', 'cre', 'cph'), email = '[email protected]', comment = "R wrapper"),
Expand Down
4 changes: 4 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## CHANGES IN ruimtehol VERSION 0.3.2

- Docs of starspace and starspace_dictionary: fix use of {} in itemize items

## CHANGES IN ruimtehol VERSION 0.3.1

- Changes in src/Starspace/src/model.cpp (EmbedModel::train). On Windows, no longer use threads as on CRAN that seems to make the package FAIL.
Expand Down
14 changes: 7 additions & 7 deletions R/embed-all-the-things.R
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
#' \item dim: size of embedding vectors [100]
#' \item epoch: number of epochs [5]
#' \item lr: learning rate [0.01]
#' \item loss: loss function {hinge, softmax} [hinge]
#' \item loss: loss function: hinge, softmax [hinge]
#' \item margin: margin parameter in hinge loss. It's only effective if hinge loss is used. [0.05]
#' \item similarity: takes value in [cosine, dot]. Whether to use cosine or dot product as similarity function in hinge loss. It's only effective if hinge loss is used. [cosine]
#' \item negSearchLimit: number of negatives sampled [50]
Expand Down Expand Up @@ -218,12 +218,12 @@ print.textspace <- function(x, ...){
#' @export
#' @return a list with elements
#' \enumerate{
#' \item{ntokens: }{The number of tokens in the data}
#' \item{nwords: }{The number of words which are part of the dictionary}
#' \item{nlabels: }{The number of labels which are part of the dictionary}
#' \item{labels: }{A character vector with the labels}
#' \item{dictionary_size: }{The size of the dictionary (nwords + nlabels)}
#' \item{dictionary: }{A data.frame with all the words and labels from the dictionary. This data.frame has columns term, is_word and is_label indicating
#' \item{ntokens: The number of tokens in the data}
#' \item{nwords: The number of words which are part of the dictionary}
#' \item{nlabels: The number of labels which are part of the dictionary}
#' \item{labels: A character vector with the labels}
#' \item{dictionary_size: The size of the dictionary (nwords + nlabels)}
#' \item{dictionary: A data.frame with all the words and labels from the dictionary. This data.frame has columns term, is_word and is_label indicating
#' for each term if it is a word or a label}
#' }
#' @examples
Expand Down

0 comments on commit 93fbe80

Please sign in to comment.