From c4bc4a2832989e80ebae90c372a0bab529732e55 Mon Sep 17 00:00:00 2001 From: Ozzie Gooen Date: Fri, 29 Jul 2022 10:26:14 -0700 Subject: [PATCH] Formatting --- packages/website/docs/Api/List.md | 3 ++- packages/website/docs/Discussions/Gallery.md | 10 +++++----- packages/website/docs/Guides/Gotchas.mdx | 15 +++++++++++---- packages/website/docs/Integrations.md | 15 ++++++++++----- 4 files changed, 28 insertions(+), 15 deletions(-) diff --git a/packages/website/docs/Api/List.md b/packages/website/docs/Api/List.md index 26c7c555..137cdf5e 100644 --- a/packages/website/docs/Api/List.md +++ b/packages/website/docs/Api/List.md @@ -78,6 +78,7 @@ See [Rescript implementation](https://rescript-lang.org/docs/manual/latest/api/b ``` filter: (list<'a>, 'a => bool) => list<'a> ``` + See [Rescript implementation of keep](https://rescript-lang.org/docs/manual/latest/api/belt/array#keep), which is functionally equivalent. ### reduce @@ -104,4 +105,4 @@ reduceReverse: (list<'b>, 'a, ('a, 'b) => 'a) => 'a Works like `reduce`, but the function is applied to each item from the last back to the first. -See [Rescript implementation](https://rescript-lang.org/docs/manual/latest/api/belt/array#reducereverse). \ No newline at end of file +See [Rescript implementation](https://rescript-lang.org/docs/manual/latest/api/belt/array#reducereverse). diff --git a/packages/website/docs/Discussions/Gallery.md b/packages/website/docs/Discussions/Gallery.md index ad06b550..be7f143b 100644 --- a/packages/website/docs/Discussions/Gallery.md +++ b/packages/website/docs/Discussions/Gallery.md @@ -3,8 +3,8 @@ sidebar_position: 2 title: Gallery --- -* [GiveWell's GiveDirectly cost effectiveness analysis](https://observablehq.com/@hazelfire/givewells-givedirectly-cost-effectiveness-analysis) by Sam Nolan -* [A Critical Review of Open Philanthropy’s Bet On Criminal Justice Reform](https://forum.effectivealtruism.org/posts/h2N9qEbvQ6RHABcae/a-critical-review-of-open-philanthropy-s-bet-on-criminal) by Nuño Sempere -* [Samotsvety Nuclear Risk Forecasts — March 2022](https://forum.effectivealtruism.org/posts/KRFXjCqqfGQAYirm5/samotsvety-nuclear-risk-forecasts-march-2022) by Nuño Sempere, Misha Yagudin, Eli Lifland -* [Adjusting probabilities for the passage of time](https://www.lesswrong.com/s/rDe8QE5NvXcZYzgZ3/p/j8o6sgRerE3tqNWdj) by Nuño Sempere -* [List of QURI Squiggle Models](https://github.com/quantified-uncertainty/squiggle-models) by Nuño Sempere, Sam Nolan, and Ozzie Gooen \ No newline at end of file +- [GiveWell's GiveDirectly cost effectiveness analysis](https://observablehq.com/@hazelfire/givewells-givedirectly-cost-effectiveness-analysis) by Sam Nolan +- [A Critical Review of Open Philanthropy’s Bet On Criminal Justice Reform](https://forum.effectivealtruism.org/posts/h2N9qEbvQ6RHABcae/a-critical-review-of-open-philanthropy-s-bet-on-criminal) by Nuño Sempere +- [Samotsvety Nuclear Risk Forecasts — March 2022](https://forum.effectivealtruism.org/posts/KRFXjCqqfGQAYirm5/samotsvety-nuclear-risk-forecasts-march-2022) by Nuño Sempere, Misha Yagudin, Eli Lifland +- [Adjusting probabilities for the passage of time](https://www.lesswrong.com/s/rDe8QE5NvXcZYzgZ3/p/j8o6sgRerE3tqNWdj) by Nuño Sempere +- [List of QURI Squiggle Models](https://github.com/quantified-uncertainty/squiggle-models) by Nuño Sempere, Sam Nolan, and Ozzie Gooen diff --git a/packages/website/docs/Guides/Gotchas.mdx b/packages/website/docs/Guides/Gotchas.mdx index f4034aaa..2c7f5b0f 100644 --- a/packages/website/docs/Guides/Gotchas.mdx +++ b/packages/website/docs/Guides/Gotchas.mdx @@ -7,28 +7,35 @@ import { SquiggleEditor } from "../../src/components/SquiggleEditor"; import Admonition from "@theme/Admonition"; ## Point Set Distributions Conversions + Point Set conversions are done with [kernel density estimation](https://en.wikipedia.org/wiki/Kernel_density_estimation), which is lossy. This might be particularly noticeable in cases where distributions should be entirely above zero. In this example, we see that the median of this (highly skewed) distribution is positive when it's in a Sample Set format, but negative when it's converted to a Point Set format. - +}`} +/> --- + This can be particularly confusing for visualizations. Visualizations automatically convert distributions into Point Set formats. Therefore, they might often show negative values, even if the underlying distribution is fully positive. We plan to later support more configuration of kernel density estimation, and for visualiations of Sample Set distributions to instead use histograms. ## Sample Set Correlations + Correlations with Sample Set distributions are a bit complicated. Monte Carlo generations with Squiggle are ordered. The first sample in one Sample Set distribution will correspond to the first sample in a distribution that comes from a resulting Monte Carlo generation. Therefore, Sample Set distributions in a chain of Monte Carlo generations are likely to all be correlated with each other. This connection breaks if any node changes to the Point Set or Symbolic format. In this example, we subtract all three types of distributions by themselves. Notice that the Sample Set distribution returns 1. The other two return the result of subtracting one normal distribution from a separate uncorrelated distribution. These results are clearly very different to each other. - SampleSet.fromDist + SampleSet.fromDist sampleSetDistToPointSet = sampleSetDist |> PointSet.fromDist symbolicDist = normal(5,2) -[sampleSetDist-sampleSetDist, sampleSetDistToPointSet-sampleSetDistToPointSet, symbolicDist-symbolicDist]`} /> \ No newline at end of file +[sampleSetDist-sampleSetDist, sampleSetDistToPointSet-sampleSetDistToPointSet, symbolicDist-symbolicDist]`} +/> diff --git a/packages/website/docs/Integrations.md b/packages/website/docs/Integrations.md index 2ec5b148..c2aa16e7 100644 --- a/packages/website/docs/Integrations.md +++ b/packages/website/docs/Integrations.md @@ -4,6 +4,7 @@ title: "Integrations" --- ## Node Packages + There are two JavaScript packages currently available for Squiggle: - [`@quri/squiggle-lang`](https://www.npmjs.com/package/@quri/squiggle-lang) @@ -11,10 +12,12 @@ There are two JavaScript packages currently available for Squiggle: Types are available for both packages. -## [Squiggle Language](https://www.npmjs.com/package/@quri/squiggle-lang) ![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-lang.svg) +## [Squiggle Language](https://www.npmjs.com/package/@quri/squiggle-lang) ![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-lang.svg) + [_See `README.md` in Github_](https://github.com/quantified-uncertainty/squiggle/tree/develop/packages/squiggle-lang#use-the-npm-package) -## [Squiggle Components](https://www.npmjs.com/package/@quri/squiggle-components) ![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-components.svg) +## [Squiggle Components](https://www.npmjs.com/package/@quri/squiggle-components) ![npm version](https://badge.fury.io/js/@quri%2Fsquiggle-components.svg) + [_See `README.md` in Github_](https://github.com/quantified-uncertainty/squiggle/tree/develop/packages/components#usage-in-a-react-project) This documentation uses `@quri/squiggle-components` frequently. @@ -22,8 +25,10 @@ This documentation uses `@quri/squiggle-components` frequently. We host [a storybook](https://squiggle-components.netlify.app/) with details and usage of each of the components made available. -## [Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=QURI.vscode-squiggle) ![npm version](https://vsmarketplacebadge.apphb.com/version/QURI.vscode-squiggle.svg) -This extention allows you to run and visualize Squiggle code. +## [Visual Studio Code Extension](https://marketplace.visualstudio.com/items?itemName=QURI.vscode-squiggle) ![npm version](https://vsmarketplacebadge.apphb.com/version/QURI.vscode-squiggle.svg) + +This extention allows you to run and visualize Squiggle code. ## [Observable Library](https://observablehq.com/@hazelfire/squiggle) -An exportable [Observable Notebook](https://observablehq.com/@hazelfire/squiggle) of the key components that you can directly import and use in Observable notebooks. \ No newline at end of file + +An exportable [Observable Notebook](https://observablehq.com/@hazelfire/squiggle) of the key components that you can directly import and use in Observable notebooks.