deploy: 8001245

alan-turing-institute · Jan 26, 2025 · f9f5497 · f9f5497
commit f9f5497
Show file tree

Hide file tree

Showing 291 changed files with 49,378 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 1a0f82af78fd96a174357eedad693495
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/00e7391285ad0a23d217120f9c20d6926001d3de4f8f5ab35f43e51a94dfeb51.png b/_images/00e7391285ad0a23d217120f9c20d6926001d3de4f8f5ab35f43e51a94dfeb51.png
diff --git a/_images/076e00af7001644d67284ed2d84bfb106d3e30ca9637c23adc8db0fca2c5b9d7.png b/_images/076e00af7001644d67284ed2d84bfb106d3e30ca9637c23adc8db0fca2c5b9d7.png
diff --git a/_images/1102d5acf830210369344c64345b23987b401afa2521cc8f6a1e39a3adc0a194.png b/_images/1102d5acf830210369344c64345b23987b401afa2521cc8f6a1e39a3adc0a194.png
diff --git a/_images/178bd07351dab10c117e96bd31c12ebdcb55ec04e301d21bd870aec2c006e739.png b/_images/178bd07351dab10c117e96bd31c12ebdcb55ec04e301d21bd870aec2c006e739.png
diff --git a/_images/1cc96366fcab69b189d48e20b148a3dfc0adad2b2cdfe0007d37cbcf4842cbe7.png b/_images/1cc96366fcab69b189d48e20b148a3dfc0adad2b2cdfe0007d37cbcf4842cbe7.png
diff --git a/_images/1eb0f54dce16aa787039d2a78fb9cdaa94e90ab054835fdfd055234bb0506296.png b/_images/1eb0f54dce16aa787039d2a78fb9cdaa94e90ab054835fdfd055234bb0506296.png
diff --git a/_images/24dc1f2ac24f427dfbe135ee1f7a80db8d7a37d4e0b7194e2c4e41e1028ade16.png b/_images/24dc1f2ac24f427dfbe135ee1f7a80db8d7a37d4e0b7194e2c4e41e1028ade16.png
diff --git a/_images/2c2c8ee16bbfcc6327079590834ae77ee505d64debb3e76564cf1e9e79036519.png b/_images/2c2c8ee16bbfcc6327079590834ae77ee505d64debb3e76564cf1e9e79036519.png
diff --git a/_images/3c68f765a2940f6a54a6c8c7f1d5ba02731462a6b740cf1fdc559402003babb7.png b/_images/3c68f765a2940f6a54a6c8c7f1d5ba02731462a6b740cf1fdc559402003babb7.png
diff --git a/_images/488ae9d16d7a67a5299c9339dd99bfac3ae118110f0de025bbcab0a268b99036.png b/_images/488ae9d16d7a67a5299c9339dd99bfac3ae118110f0de025bbcab0a268b99036.png
diff --git a/_images/4af075153c0c37778b7d6eb6ba678cf64909a1a89089d2b520ccfab3b3a44931.png b/_images/4af075153c0c37778b7d6eb6ba678cf64909a1a89089d2b520ccfab3b3a44931.png
diff --git a/_images/4bc19ff34148935d8dfa16c86d3b8009f15dfe4d47334fd88dd5ed18c2d60c43.png b/_images/4bc19ff34148935d8dfa16c86d3b8009f15dfe4d47334fd88dd5ed18c2d60c43.png
diff --git a/_images/4ea045a3a63de9128e016f22cc479595544073cefa39337d1b6f4deca3b55c94.png b/_images/4ea045a3a63de9128e016f22cc479595544073cefa39337d1b6f4deca3b55c94.png
diff --git a/_images/4ed8679ebd728d3ce67c6d3f73b4811a21d5daf456c82f1766f947d065bbe9a6.png b/_images/4ed8679ebd728d3ce67c6d3f73b4811a21d5daf456c82f1766f947d065bbe9a6.png
diff --git a/_images/509795073e05838cebf6c8d793f8a1c4ce34f6c50d0a2f6c91c1d6f0a646357f.png b/_images/509795073e05838cebf6c8d793f8a1c4ce34f6c50d0a2f6c91c1d6f0a646357f.png
diff --git a/_images/51e09db13ce7191895d405687afb40d85c9cd55b12f34b072bc6a8cdcead41c7.png b/_images/51e09db13ce7191895d405687afb40d85c9cd55b12f34b072bc6a8cdcead41c7.png
diff --git a/_images/522e4b7ec7dc871201c328a5ee2606310e78fb959220e1a2a9b11c2860659791.png b/_images/522e4b7ec7dc871201c328a5ee2606310e78fb959220e1a2a9b11c2860659791.png
diff --git a/_images/571b9c0473337cb87e975564853ab154297f228dcd399e21408c5a5d646db2d0.png b/_images/571b9c0473337cb87e975564853ab154297f228dcd399e21408c5a5d646db2d0.png
diff --git a/_images/5a1b9c5ce24cf77cd4270719c96568b4e3108bf4daf3c230934915564ed79778.png b/_images/5a1b9c5ce24cf77cd4270719c96568b4e3108bf4daf3c230934915564ed79778.png
diff --git a/_images/6318dca69a7fbaa564cc6c6309ad8dde2fb0a9a542828a8fb905d4a684bd7305.png b/_images/6318dca69a7fbaa564cc6c6309ad8dde2fb0a9a542828a8fb905d4a684bd7305.png
diff --git a/_images/633eb6dce0859a9b8298cb085d99a6a4d47d66be4846a5431d66b055089f226f.png b/_images/633eb6dce0859a9b8298cb085d99a6a4d47d66be4846a5431d66b055089f226f.png
diff --git a/_images/66d2f5ddb8c6b4c88ce7b8cd657b839abd722880fcdc9b7afe6aad22b901dd88.png b/_images/66d2f5ddb8c6b4c88ce7b8cd657b839abd722880fcdc9b7afe6aad22b901dd88.png
diff --git a/_images/69155f2d6771a4e04a41e8895f57ec7eff76ff407340f19b947c9d2d64603883.png b/_images/69155f2d6771a4e04a41e8895f57ec7eff76ff407340f19b947c9d2d64603883.png
diff --git a/_images/69d9ac2bc475aab34768f0f8ccacb79dc6424d401fbd3b0129cdb7016b9cff7b.png b/_images/69d9ac2bc475aab34768f0f8ccacb79dc6424d401fbd3b0129cdb7016b9cff7b.png
diff --git a/_images/74407a92cd9c13e7e4ff0789405abbdcf75c9e26963d31986c0ccacfa9dff556.png b/_images/74407a92cd9c13e7e4ff0789405abbdcf75c9e26963d31986c0ccacfa9dff556.png
diff --git a/_images/758de58cada0eddb31da248a36ce2a3fc4fadfe065d7c3e0d980af4c4f2b882c.png b/_images/758de58cada0eddb31da248a36ce2a3fc4fadfe065d7c3e0d980af4c4f2b882c.png
diff --git a/_images/80a3533503df36866685a054f0e8a6ea8fc5844e211b1b5ee3de8466a084bdcd.png b/_images/80a3533503df36866685a054f0e8a6ea8fc5844e211b1b5ee3de8466a084bdcd.png
diff --git a/_images/849f7ec3940d295224493cfa01e608da92e53123a9503ba3f3b8dd312a9e0693.png b/_images/849f7ec3940d295224493cfa01e608da92e53123a9503ba3f3b8dd312a9e0693.png
diff --git a/_images/85b6a9b19e2e86b56cf2104458ba9f787a54896fcd452fe1fd789ef70590280e.png b/_images/85b6a9b19e2e86b56cf2104458ba9f787a54896fcd452fe1fd789ef70590280e.png
diff --git a/_images/97635637c92862857de9ca5957ab760a23ea9da7e42e23827b898be170aac9e1.png b/_images/97635637c92862857de9ca5957ab760a23ea9da7e42e23827b898be170aac9e1.png
diff --git a/_images/9f3f4f597ff02b15f6aa76fa7aea1f36648133beeae8f006a80c2f9e158d841b.png b/_images/9f3f4f597ff02b15f6aa76fa7aea1f36648133beeae8f006a80c2f9e158d841b.png
diff --git a/_images/b65a737d863cf5630de0b9750604b95e15eb4b5952e184c48c50e88cb19d5792.png b/_images/b65a737d863cf5630de0b9750604b95e15eb4b5952e184c48c50e88cb19d5792.png
diff --git a/_images/b7a59c635e7c612edcc8359da18e8f65c53e75b7f1490fb69b4d692eee452c36.png b/_images/b7a59c635e7c612edcc8359da18e8f65c53e75b7f1490fb69b4d692eee452c36.png
diff --git a/_images/be8faac5487cbb19137388cc8c7d4dbc3d588e8261049c1e9bfa3e3eadf561e3.png b/_images/be8faac5487cbb19137388cc8c7d4dbc3d588e8261049c1e9bfa3e3eadf561e3.png
diff --git a/_images/c29dbd4f7f0c5166fa175351f3030a04b98a190064ae7ffe316cd46fab78f3e0.png b/_images/c29dbd4f7f0c5166fa175351f3030a04b98a190064ae7ffe316cd46fab78f3e0.png
diff --git a/_images/convnp_arch.png b/_images/convnp_arch.png
diff --git a/_images/deepsensor_application_examples.png b/_images/deepsensor_application_examples.png
diff --git a/_images/deepsensor_design.png b/_images/deepsensor_design.png
diff --git a/_images/e3893525400c6f9ee54bcf805009ab9021207b8b1362478cd929eeea8dd5731d.png b/_images/e3893525400c6f9ee54bcf805009ab9021207b8b1362478cd929eeea8dd5731d.png
diff --git a/_images/e86ea5a44aa3d5c7e6ddbcd55571c2fb08b847ac901c9f041e0e98ca17c078c3.png b/_images/e86ea5a44aa3d5c7e6ddbcd55571c2fb08b847ac901c9f041e0e98ca17c078c3.png
diff --git a/_images/e960e363e424d7894ad6f13e6c5637e8995991709ddc5afc65a664f81dfc8487.png b/_images/e960e363e424d7894ad6f13e6c5637e8995991709ddc5afc65a664f81dfc8487.png
diff --git a/_images/f50db2d4af9adf756b379f55bab153c1c600cc9c7ba7f22acd354e7494585c3e.png b/_images/f50db2d4af9adf756b379f55bab153c1c600cc9c7ba7f22acd354e7494585c3e.png
diff --git a/_images/f5be28482b9f49c4d04fdb59b6502f56c0f8ee636541aacf73452bad89035642.png b/_images/f5be28482b9f49c4d04fdb59b6502f56c0f8ee636541aacf73452bad89035642.png
diff --git a/_images/f708fa3993b7fa909597e8666480a2e0e5667f0a2c51277a76a90fafa6097115.png b/_images/f708fa3993b7fa909597e8666480a2e0e5667f0a2c51277a76a90fafa6097115.png
diff --git a/_images/index_api.svg b/_images/index_api.svg
diff --git a/_images/index_community2.png b/_images/index_community2.png
diff --git a/_images/index_getting_started.svg b/_images/index_getting_started.svg
diff --git a/_images/index_user_guide.svg b/_images/index_user_guide.svg
diff --git a/_sources/community/code_of_conduct.md b/_sources/community/code_of_conduct.md
@@ -0,0 +1,2 @@
+```{include} ../../CODE_OF_CONDUCT.md
+```
diff --git a/_sources/community/contributing.md b/_sources/community/contributing.md
@@ -0,0 +1,2 @@
+```{include} ../../CONTRIBUTING.md
+```
diff --git a/_sources/community/faq.md b/_sources/community/faq.md
@@ -0,0 +1,97 @@
+# Community FAQ
+
+This FAQ aims to answer common questions about the DeepSensor library. It is our way to streamline the onboarding process and clarify expectations.
+
+```{note}
+If you have a question you'd like to see answered here, make a request in a issue or in the [Slack channel](https://ai4environment.slack.com/archives/C05NQ76L87R).
+```
+
+## Questions
+
+**Q: Why doesn't the package name `DeepSensor` mention NPs if it's all about neural processes?**
+
+**Answer:**
+DeepSensor aims to be extensible to models that are not necessarily NPs.
+We also wanted to keep the name short and easy to remember.
+The name `DeepSensor` is a reference to the fact that the library is about deep learning and sensor data.
+
+---
+
+**Q: How can I contribute?**
+
+**Answer:**
+There are many ways to contribute, from writing code and fixing bugs to improving documentation or translating content.
+Check our [](./contributing.md) guide.
+
+---
+
+**Q: Do I need to sign a Contributor License Agreement (CLA)?**
+
+**Answer:** At the current time, we do not require a CLA from our contributors.
+
+---
+
+**Q: How do I report a bug?**
+
+**Answer:** Please submit an issue in our GitHub repository. Make sure to provide detailed information, including steps to reproduce the bug and the expected outcome.
+
+---
+
+**Q: How do I request a new feature?**
+
+**Answer:** Open a new issue on our GitHub repository and label it as a feature request. Describe the feature in detail and its potential benefits.
+
+---
+
+**Q: How can I get in touch with other contributors or maintainers?**
+
+**Answer:**
+Request to join our Slack channel to stay in touch with other contributors and maintainers. You can join by [signing up for the Turing Environment & Sustainability stakeholder community](https://forms.office.com/pages/responsepage.aspx?id=p_SVQ1XklU-Knx-672OE-ZmEJNLHTHVFkqQ97AaCfn9UMTZKT1IwTVhJRE82UjUzMVE2MThSOU5RMC4u). The form includes a question on signing up for the Slack team, where you can find DeepSensor's channel.
+
+We also have a regular community Zoom call (join the Slack channel or get in touch to find out more).
+
+---
+
+**Q: How do I set up the development environment?**
+
+**Answer:** Follow the instructions in our developer documentation. If you run into issues, ask in our [community chat](https://ai4environment.slack.com/archives/C05NQ76L87R) (on Slack).
+
+---
+
+**Q: Do you have a code of conduct?**
+
+**Answer:**
+Yes, we value a respectful and inclusive community.
+Please read our [](./code_of_conduct.md) before contributing.
+
+---
+
+**Q: Can I contribute even if I'm not a coder?**
+
+**Answer:** Absolutely! Contributions can be made in the form of documentation, design, testing, and more. Everyone's skills are valuable. Join our Slack discussion to learn more.
+
+---
+
+**Q: How do I claim an issue to work on?**
+
+**Answer:** Comment on the issue expressing your interest to help out. If the issue is unassigned, a maintainer will likely assign it to you.
+
+---
+
+**Q: What's the process for proposing a significant change?**
+
+**Answer:** For significant changes, it's a good practice to first open a discussion or issue to gather feedback. Once there's a consensus, you can proceed with a pull request.
+
+---
+
+**Q: How can I get my pull request (PR) merged?**
+
+**Answer:** Ensure your PR follows the contribution guidelines, passes all tests, and has been reviewed by at least one maintainer. Address any feedback provided.
+
+---
+
+**Q: How is credit given to contributors?**
+
+**Answer:**
+Contributors are acknowledged via an `all-contributors` system, which records contributions (code or non-code) at the end of the project's README.
+Code contributions are acknowledged in our release notes.
diff --git a/_sources/community/index.md b/_sources/community/index.md
@@ -0,0 +1,7 @@
+# Community
+
+The DeepSensor community is a group of users and contributors who are interested in the development of DeepSensor. The community is open to anyone who is interested in DeepSensor. The community is a place to ask questions, discuss ideas, and share your work.
+
+If you are interested in joining the community, please request to join our Slack channel. You can join by [signing up for the Turing Environment & Sustainability stakeholder community](https://forms.office.com/pages/responsepage.aspx?id=p_SVQ1XklU-Knx-672OE-ZmEJNLHTHVFkqQ97AaCfn9UMTZKT1IwTVhJRE82UjUzMVE2MThSOU5RMC4u). The form includes a question on signing up for the Slack team, where you can find DeepSensor's channel.
+
+We welcome contributions from the community. If you are interested in contributing to DeepSensor, please read the [Contributing Guide](./contributing.md).