stan-dev / stan-dev/rstan

Update rosetta definitions

Open
#310 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
R
Stars
1.1k
Forks
266
Avg merge
2h 56m
Merged PRs (30d)
1

Description

Summary:

Replace the rosetta data frame with a more informative data structure containing a list of all signatures for each function and possibly extra info such as keywords.

Description:

Currently I maintain a json file in https://github.com/jrnold/stan-language-definitions that parses the function definitions in stan-functions-2.10.0 and adds additional information, including keywords. I think this would be potentially more useful for autocomplete and other features for which rosetta could be used.

For example, the entry for append_row looks like this:

   "append_row": {
      "density": false,
      "deprecated": false,
      "keyword": false,
      "lccdf": false,
      "lcdf": false,
      "lpdf": false,
      "lpmf": false,
      "math": true,
      "operator": false,
      "sampling": null,
      "signatures": [
        {
          "args": [
            {
              "name": "x",
              "type": "matrix"
            },
            {
              "name": "y",
              "type": "matrix"
            }
          ],
          "return": "matrix"
        },
        {
          "args": [
            {
              "name": "x",
              "type": "matrix"
            },
            {
              "name": "y",
              "type": "row_vector"
            }
          ],
          "return": "matrix"
        },
        {
          "args": [
            {
              "name": "x",
              "type": "row_vector"
            },
            {
              "name": "y",
              "type": "matrix"
            }
          ],
          "return": "matrix"
        },
        {
          "args": [
            {
              "name": "x",
              "type": "row_vector"
            },
            {
              "name": "y",
              "type": "row_vector"
            }
          ],
          "return": "matrix"
        },

and the one for normal looks like this,

    "normal_lpdf": {
      "density": true,
      "deprecated": false,
      "keyword": false,
      "lccdf": false,
      "lcdf": false,
      "lpdf": true,
      "lpmf": false,
      "math": false,
      "operator": false,
      "sampling": "normal",
      "signatures": [
        {
          "args": [
            {
              "name": "y",
              "type": "reals"
            },
            {
              "name": "mu",
              "type": "reals"
            },
            {
              "name": "sigma",
              "type": "reals"
            }
          ],
          "return": "real"
        }
      ]
    },

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the current rosetta data frame with the stan-functions-2.10.0 definitions and the linked stan-language-definitions JSON. Determine how all function signatures and metadata such as keywords should be represented; done means rosetta uses the more informative structure for autocomplete and related features.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.