![](\"https://github.com/rose-lang/rose-icons/raw/efcc218832d65970a47bed597ee11cecd3d1cc3c/svg/encircled-rose.svg\")
\nRose
\nicon by Aaron Weiss / CC BY 4.0
\n![\"npm\"](\"https://img.shields.io/npm/v/rose\")
![\"license\"](\"https://img.shields.io/github/license/rose-lang/rose\")
![\"Build\"](\"https://github.com/rose-lang/rose/actions/workflows/build.yml/badge.svg\")
\n\nRose is an automatic differentiation engine for the web, inspired by [JAX][].\n\n## Installation\n\nWith [npm][]:\n\n```sh\nnpm i rose\n```\n\nWith [Yarn][]:\n\n```sh\nyarn add rose\n```\n\nWith [pnpm][]:\n\n```sh\npnpm add rose\n```\n\nWith [Bun][]:\n\n```sh\nbun add rose\n```\n\n## Usage\n\nThis example defines custom derivatives for the builtin JavaScript logarithm and\npower functions, then computes the output, gradient, and Hessian for the power\nfunction applied with base 2 and exponent 3:\n\n```js\nimport { Dual, Real, Vec, add, compile, div, fn, mul, opaque, vjp } from \"rose\";\n\nconst log = opaque([Real], Real, Math.log);\nlog.jvp = fn([Dual], Dual, ({ re: x, du: dx }) => {\n return { re: log(x), du: div(dx, x) };\n});\n\nconst pow = opaque([Real, Real], Real, Math.pow);\npow.jvp = fn([Dual, Dual], Dual, ({ re: x, du: dx }, { re: y, du: dy }) => {\n const z = pow(x, y);\n return { re: z, du: mul(add(mul(dx, div(y, x)), mul(dy, log(x))), z) };\n});\n\nconst Vec2 = Vec(2, Real);\nconst Mat2 = Vec(2, Vec2);\n\nconst f = fn([Vec2], Real, ([x, y]) => pow(x, y));\nconst g = fn([Vec2], Vec2, (v) => vjp(f)(v).grad(1));\nconst h = fn([Vec2], Mat2, (v) => {\n const { grad } = vjp(g)(v);\n return [grad([1, 0]), grad([0, 1])];\n});\n\nconst funcs = await Promise.all([compile(f), compile(g), compile(h)]);\nconsole.log(funcs.map((func) => func([2, 3])));\n```\n\n### With Vite\n\nIf you are using [Vite][] then you will need to also install the\n[vite-plugin-top-level-await][] package, because Rose internally uses [top-level\n`await`][], which Vite does not directly support. You must also include the\nfollowing in your Vite config:\n\n```js\nimport { defineConfig } from \"vite\";\nimport topLevelAwait from \"vite-plugin-top-level-await\";\n\nexport default defineConfig({\n // the plugin described above\n plugins: [topLevelAwait()],\n\n // Vite bundles external dependencies by default in development mode, but that\n // process does not include assets; this option disables that particular kind\n // of bundling for Rose so that it can use its internal WebAssembly module\n optimizeDeps: { exclude: [\"rose\"] },\n});\n```\n\n## Contributing\n\nSee [`CONTRIBUTING.md`][].\n\n## License\n\nRose is licensed under the [MIT License][].\n\n[`CONTRIBUTING.md`]: https://github.com/rose-lang/rose/blob/main/CONTRIBUTING.md\n[Bun]: https://bun.sh/\n[JAX]: http://jax.readthedocs.io/\n[MIT License]: https://github.com/rose-lang/rose/blob/main/LICENSE\n[npm]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\n[pnpm]: https://pnpm.io/installation\n[top-level `await`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await#top_level_await\n[vite-plugin-top-level-await]: https://www.npmjs.com/package/vite-plugin-top-level-await\n[Vite]: https://vitejs.dev/\n[Yarn]: https://classic.yarnpkg.com/lang/en/docs/install/\n","maintainers":[{"name":"samestep","email":"sam@samestep.com"}],"time":{"modified":"2024-04-10T03:53:49.166Z","created":"2014-02-14T07:24:48.482Z","0.0.0":"2014-02-14T07:24:50.356Z","0.0.1":"2014-02-14T07:42:23.257Z","0.1.0-beta":"2016-09-20T05:18:17.058Z","0.2.0":"2023-09-18T01:01:30.751Z","0.2.1":"2023-09-18T01:54:38.358Z","0.2.2":"2023-09-18T13:53:31.594Z","0.3.0":"2023-09-20T01:16:14.688Z","0.3.1":"2023-09-20T23:03:44.600Z","0.3.2":"2023-09-21T05:43:54.470Z","0.3.3":"2023-09-26T00:22:17.788Z","0.3.4":"2023-09-27T23:45:18.369Z","0.3.5":"2023-09-28T05:20:03.357Z","0.4.0":"2023-10-06T04:42:39.067Z","0.4.1":"2023-10-10T01:46:26.519Z","0.4.2":"2023-10-10T04:42:18.052Z","0.4.3":"2023-11-09T16:53:16.105Z","0.4.4":"2023-11-09T19:45:22.158Z","0.4.5":"2023-11-16T18:36:55.803Z","0.4.6":"2024-01-15T16:43:43.832Z","0.4.7":"2024-01-24T20:10:51.462Z","0.4.8":"2024-03-20T14:48:24.498Z","0.4.9":"2024-03-27T19:51:59.808Z","0.4.10":"2024-04-10T03:53:49.006Z"},"readmeFilename":"README.md","license":"MIT","homepage":"https://github.com/rose-lang/rose#readme","repository":{"type":"git","url":"git+https://github.com/rose-lang/rose.git"},"bugs":{"url":"https://github.com/rose-lang/rose/issues"}}