Add Docs on which ML models take which as inputs #213
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
utsav-pal
commented
Feb 17, 2025
README.md
Outdated
| @@ -19,6 +19,32 @@ To be able to run the tests locally it is recommended to use conda & pip and fol | |||
|
|
|||
| It is possbile to run the app locally by setting the required environment variables listed at the top of the [app](pvnet_app/app.py), these should point to the relevant data sources and DBs for the environment you want to run the app in. You will need to make sure you have opened a connection to the DB, as well as authenticating against any cloud providers where data may be stored (e.g if using AWS S3 then can do this via the AWS CLI command `aws configure`), a simple [notebook](scripts/run_app_local_example.ipynb) has been created as an example. | |||
|
|
|||
There was a problem hiding this comment.
Thank you so much for having a go at this. I should have put more detail in the github issue.
I think the columns should be
- Model name
- Satellite
- NWP UKV
- NWP ECMWF
- Legacy ( this is true if uses_ocf_data_sampler=False)
- PVNet Hugging Face link
- PVNet Summation Hugging Face link
For the HF link, a url needs to be made out of huggingface repo here and the version in the line below. A simialr url could be made for the summation model
Perhaps I can list them out, and then
- pvnet_v2. This uses satellite and both nwps
- pvnet_v2-sat0-samples-v1. This uses satellite and both nwps, but need to check this
- pvnet_v2-sat0-only-samples-v1. Satellite only
- pvnet_v2-ukv-only-samples-v1. Only UKV
- pvnet_ecmwf. ECMWF only
- pvnet_day_ahead, ECMWF and UKV
Legacy ones - pvnet_v2, Satellite and both NWPs
- pvnet_ecmwf. ECMWF only
- pvnet_day_ahead. Satellite and both NWPs
There was a problem hiding this comment.
Ok I will try this
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this PR update the README file only
This pull request addresses issue #212 by providing comprehensive documentation of the machine learning models used in the
uk-pvnet-appand their required inputs. The documentation is generated into a.mdfile, which includes a table summarizing each model, its inputs, and key configuration flags.Fixes #212