PVNet 4.1.4__tar.gz → 4.1.6__tar.gz

{pvnet-4.1.4 → pvnet-4.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PVNet
-Version: 4.1.4
+Version: 4.1.6
 Summary: PVNet
 Author-email: Peter Dudfield <info@openclimatefix.org>
 Description-Content-Type: text/markdown

{pvnet-4.1.4 → pvnet-4.1.6}/PVNet.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PVNet
-Version: 4.1.4
+Version: 4.1.6
 Summary: PVNet
 Author-email: Peter Dudfield <info@openclimatefix.org>
 Description-Content-Type: text/markdown

pvnet-4.1.6/pvnet/__init__.py

@@ -0,0 +1,2 @@
+"""PVNet"""
+__version__ = "4.1.6"

{pvnet-4.1.4 → pvnet-4.1.6}/pvnet/models/base_model.py

@@ -12,6 +12,7 @@ import hydra
 import lightning.pytorch as pl
 import matplotlib.pyplot as plt
 import pandas as pd
+import pkg_resources
 import torch
 import torch.nn.functional as F
 import wandb
@@ -316,7 +317,7 @@ class PVNetModelHubMixin(PyTorchModelHubMixin):
         push_to_hub: bool = False,
         wandb_repo: Optional[str] = None,
         wandb_ids: Optional[Union[list[str], str]] = None,
-        card_template_path=None,
+        card_template_path: Optional[Path] = None,
         revision: str = "main",
         **kwargs,
     ) -> Optional[str]:
@@ -366,6 +367,47 @@ class PVNetModelHubMixin(PyTorchModelHubMixin):
             # Taylor the data config to the model being saved
             minimize_data_config(new_data_config_path, new_data_config_path, self)
 
+        card = self.create_hugging_face_model_card(repo_id,
+                                                  wandb_repo,
+                                                  wandb_ids,
+                                                  card_template_path)
+
+        (save_directory / "README.md").write_text(str(card))
+
+        if push_to_hub:
+            api = HfApi()
+
+            api.upload_folder(
+                repo_id=repo_id,
+                repo_type="model",
+                folder_path=save_directory,
+                revision=revision,
+            )
+
+        return None
+
+    @staticmethod
+    def create_hugging_face_model_card(repo_id: Optional[str] = None,
+                                      wandb_repo: Optional[str] = None,
+                                      wandb_ids: Optional[Union[list[str], str]] = None,
+                                      card_template_path: Optional[Path] = None
+    ) -> ModelCard:
+        """
+        Creates Hugging Face model card
+
+        Args:
+            repo_id (`str`, *optional*):
+                ID of your repository on the Hub. Used only if `push_to_hub=True`. Will default to
+                the folder name if not provided.
+            wandb_repo: Identifier of the repo on wandb.
+            wandb_ids: Identifier(s) of the model on wandb.
+            card_template_path: Path to the HuggingFace model card template. Defaults to card in
+                PVNet library if set to None.
+
+        Returns:
+            card: ModelCard - Hugging Face model card object
+        """
+
         # Get appropriate model card
         model_name = repo_id.split("/")[1]
         if model_name == "windnet_india":
@@ -390,26 +432,25 @@ class PVNetModelHubMixin(PyTorchModelHubMixin):
             link = f"https://wandb.ai/{wandb_repo}/runs/{wandb_id}"
             wandb_links += f" - [{link}]({link})\n"
 
+        # Find package versions for OCF packages
+        packages_to_display = ["pvnet", "ocf-data-sampler"]
+        packages_and_versions = {
+            package_name: pkg_resources.get_distribution(package_name).version
+            for package_name in packages_to_display
+        }
+
+        package_versions_markdown = ""
+        for package, version in packages_and_versions.items():
+            package_versions_markdown += f" - {package}=={version}\n"
+
         card = ModelCard.from_template(
             card_data,
             template_path=card_template_path,
             wandb_links=wandb_links,
+            package_versions=package_versions_markdown
         )
 
-        (save_directory / "README.md").write_text(str(card))
-
-        if push_to_hub:
-            api = HfApi()
-
-            api.upload_folder(
-                repo_id=repo_id,
-                repo_type="model",
-                folder_path=save_directory,
-                revision=revision,
-            )
-
-        return None
-
+        return card
 
 class BaseModel(pl.LightningModule, PVNetModelHubMixin):
     """Abstract base class for PVNet submodels"""

{pvnet-4.1.4 → pvnet-4.1.6}/pvnet/models/model_cards/pv_india_model_card_template.md

@@ -47,5 +47,10 @@ Trained on a single NVIDIA Tesla T4
 
 ### Software
 
+This model was trained using the following Open Climate Fix packages:
+
 - [1] https://github.com/openclimatefix/PVNet
 - [2] https://github.com/openclimatefix/ocf-data-sampler
+
+The versions of these packages can be found below:
+{{ package_versions }}

{pvnet-4.1.4 → pvnet-4.1.6}/pvnet/models/model_cards/pv_uk_regional_model_card_template.md

@@ -50,5 +50,10 @@ Trained on a single NVIDIA Tesla T4
 
 ### Software
 
+This model was trained using the following Open Climate Fix packages:
+
 - [1] https://github.com/openclimatefix/PVNet
 - [2] https://github.com/openclimatefix/ocf-data-sampler
+
+The versions of these packages can be found below:
+{{ package_versions }}

{pvnet-4.1.4 → pvnet-4.1.6}/pvnet/models/model_cards/wind_india_model_card_template.md

@@ -47,5 +47,10 @@ Trained on a single NVIDIA Tesla T4
 
 ### Software
 
+This model was trained using the following Open Climate Fix packages:
+
 - [1] https://github.com/openclimatefix/PVNet
 - [2] https://github.com/openclimatefix/ocf-data-sampler
+
+The versions of these packages can be found below:
+{{ package_versions }}

pvnet-4.1.4/pvnet/__init__.py

@@ -1,2 +0,0 @@
-"""PVNet"""
-__version__ = "4.1.4"