Skip to content

Added training.md Docs#107

Closed
Sharkyii wants to merge 6 commits intoopenclimatefix:mainfrom
Sharkyii:docs/training
Closed

Added training.md Docs#107
Sharkyii wants to merge 6 commits intoopenclimatefix:mainfrom
Sharkyii:docs/training

Conversation

@Sharkyii
Copy link
Copy Markdown

This PR adds training.md file to make it more accessible and user-friendly for open-source contributors.

The new file maintains all the essential technical information but presents it in a more approachable, clearer explanations and better organization. It also adds important information about using local data (setting public: false) and addresses the Hydra override error that users might encounter with the experiment_simple configuration.

Fixes #7

How Has This Been Tested?

  • Yes

I've verified that all the technical information in file is preserved. The configuration examples have been checked for accuracy, and the troubleshooting section includes all the previously documented issues with their solutions.

If your changes affect data processing, have you plotted any changes? i.e. have you done a quick sanity check?

  • N/A(documentation-only change)

Checklist:

  • My code follows OCF's coding style guidelines
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked my code and corrected any misspellings

@siddharth7113
Copy link
Copy Markdown
Contributor

siddharth7113 commented Dec 24, 2025

Hi @Sharkyii , This is a great start, but it would be good if you include the tested instructions from here

Thanks for doing this, making docs have been on our to-do list for a long time.

@Sharkyii
Copy link
Copy Markdown
Author

@siddharth7113 , I have merged the all testing instruction as mentioned in getting_started.md.

Updated training guide for PVNet to clarify configuration details and best practices.
@Sharkyii Sharkyii closed this Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

train model + evaluate model

2 participants