squiggle/packages/website/docs/Future-Features.md

114 lines
5.6 KiB
Markdown
Raw Normal View History

2022-02-10 01:53:33 +00:00
---
2022-03-25 02:08:46 +00:00
sidebar_position: 4
2022-02-10 01:53:33 +00:00
---
# Future Features
2022-04-10 23:15:46 +00:00
2022-02-10 01:53:33 +00:00
Squiggle is still very early. The main first goal is to become stable. This means having a clean codebase, having decent test coverage, and having a syntax we are reasonably confident in. Later on, there are many other features that will be interesting to explore.
## Programming Language Features
2022-04-10 23:15:46 +00:00
2022-02-10 01:53:33 +00:00
- Equality (a == b)
- If/else statements
2022-04-10 23:15:46 +00:00
- Arrays
2022-02-10 01:53:33 +00:00
- Tables / Matrices
- Simple objects
- A simple type system
2022-04-10 23:15:46 +00:00
- Simple module system (`Dist.Normal` instead of `normal`)
2022-02-10 01:53:33 +00:00
- A simple time library & notation
- Optional and default paramaters for functions
- Anonymous Functions (This is particularly convenient in cases where tiny functions are submitted in forecasting competitions)
- A notation to limit the domain of functions. For example, maybe a function only applies for t=[2 to 20]
- Custom parser (Right now we're using Math.js's parser, which doesn't give us much flexibility)
- "Partial-domain" distributions. For example, maybe someone has a distribution for when AGI will happen, but doesn't want to make any estimates past 2200.
## Distribution Features
2022-04-10 23:15:46 +00:00
`Distribution.fromSamples([])`
2022-02-10 01:53:33 +00:00
Converts a list of samples, for example, from Guesstimate, into a distribution shape. Maybe takes a list of optional parameters.
2022-04-10 23:15:46 +00:00
`Distribution.fromCoordinates({xs, ys})`
2022-02-10 01:53:33 +00:00
Convert XY coordinates into a distribution. Figure out a good way to do this for continuous, discrete, and mixed distributions.
[Metalog Distribution](https://en.wikipedia.org/wiki/Metalog_distribution)
Add the Metalog distribution, and some convenient methods for generating these distributions. This might be a bit tricky because we might need or build a library to fit data. There's no Metalog javascript library yet, this would be pretty useful. There's already a Metalog library in Python, so that one could be used for inspiration.
2022-04-10 23:15:46 +00:00
`Distribution.smoothen(p)`
2022-02-18 12:51:34 +00:00
Takes a distribution and smoothens it. For example, [Elicit Forecast](https://forecast.elicit.org/) does something like this, with uniform distributions.
2022-02-10 01:53:33 +00:00
## Major Future Additions
2022-02-18 12:51:34 +00:00
**Probabilities**
Right now Squiggle mostly works with probability distributions only, but it should also work smoothly with probabilities.
**Scoring**
Have functions to score probabilities, probability distributions, and functions that return probability distributions.
2022-02-10 01:53:33 +00:00
**Full javascript library**
A full Javascript library that accesses most of the probabilistic functionality of Squiggle, but can be used directly in javascript functions.
**Importance & quality scores**
Workflows/functionality to declare the importance and coveredness of each part of the paramater space. For example, some subsets of the paramater space of a function might be much more important to get right than others. Similarly, the analyst might be much more certain about some parts than others. Ideally. they could decline sections.
**An interface to interpret & score Squiggle files**
2022-04-10 23:15:46 +00:00
Squiggle functions need to be aggregated and scored. This should be done outside one Squiggle file. Maybe this should also be done in Squiggle, or maybe it should be done using Javascript.
2022-02-10 01:53:33 +00:00
My guess is that there should eventually be some way for people to declare that some of their Squiggle values are meant to be formally declared, to be scored and similar by others. Then other programs can read these files, and either use the values, or score them.
Of course, we'd also need good math for how the scoring should work, exactly.
This interface should also be able to handle changing Squiggle values. This is because people would be likely to want to update their functions over time, and that should be taken into account for scoring.
**Easily call other functions**
It would be great to be able to call other people's Squiggle functions, from other Squiggle functions. This could raise a whole bunch of challenging issues. Additionally, it would be neat to call other data, both from knowledge graphs, and from regular APIs. Note that this could obviously complicate scoring a lot; I imagine that either easy scoring, or simple data fetching, would have to accept sacrifices.
2022-02-10 18:47:27 +00:00
**Correlated uncertainties**
2022-04-10 23:15:46 +00:00
Right now there's no functionality to declare that two different distributions are correlated.
2022-02-10 18:47:11 +00:00
2022-02-10 18:47:27 +00:00
**Static / Sensitivity Analysis**
2022-02-10 18:47:11 +00:00
Guesstimate has Sensitivity analysis that's pretty useful. This could be quite feasible to add, though it will likely require some thinking.
2022-02-10 18:47:27 +00:00
**Annotation**
2022-02-10 18:47:11 +00:00
It might be useful to allow people to annotate functions and variables with longer descriptions, maybe Markdown. This could very much help interpretation/analysis of these items.
2022-02-18 12:51:49 +00:00
**Randomness Seeds**
2022-02-12 11:11:17 +00:00
Right now, Monte Carlo simulations are totally random. It would be nicer to be able to enter a seed somehow in order to control the randomness. Or, with the same seed, the function should always return the same values. This would make debugging and similar easier.
2022-02-11 16:30:40 +00:00
## Major Standard Language Features
2022-04-10 23:15:46 +00:00
2022-02-11 16:30:40 +00:00
- Some testing story.
- A custom code highlighting format.
- Possibly a decent web GUI (a much more advanced playground).
- A VS Code extention and similar.
## Bugs
2022-04-10 23:15:46 +00:00
- Discrete distributions are particularly buggy. Try `mm(1,2,3,4,5,6,7,8,9,10) .* (5 to 8)`
2022-03-25 02:08:46 +00:00
## New Functions
### Distributions
2022-04-10 23:15:46 +00:00
```js
2022-04-10 23:15:46 +00:00
cauchy();
pareto();
metalog();
2022-03-25 02:08:46 +00:00
```
Possibly change mm to mix, or mx(). Also, change input format, maybe to mx([a,b,c], [a,b,c]).
### Functions
2022-04-10 23:15:46 +00:00
```js
2022-04-10 23:15:46 +00:00
samples(distribution, n);
toPdf(distribution);
toCdf(distribution);
toHash(distribution);
trunctate(distribution, leftValue, rightValue);
leftTrunctate(distribution, leftValue);
rightTrunctate(distribution, rightValue);
distributionFromSamples(array, params);
distributionFromPoints();
distributionFromHash();
2022-03-25 02:08:46 +00:00
```