update documentation

Author: tamnva

docs/source/examples.rst

@@ -12,12 +12,13 @@ The configuration file ``config.yml`` and data for this example can be found `he
    from hydroecolstm.utility.plot import plot
    from hydroecolstm.data.read_config import read_config
    from hydroecolstm.model.create_model import create_model
+   from hydroecolstm.interface.utility import write_yml_file
    from hydroecolstm.utility.evaluation_function import EvaluationFunction
    from hydroecolstm.data.read_data import read_forecast_data
    import matplotlib.pyplot as plt
    from pathlib import Path
    import torch
-   
+
    #-----------------------------------------------------------------------------#
    #                        Set up, train, test model                            #
    #-----------------------------------------------------------------------------#
@@ -81,7 +82,8 @@ The configuration file ``config.yml`` and data for this example can be found `he
    torch.save(data, Path(config["output_directory"][0], "data.pt"))
    torch.save(model.state_dict(), 
               Path(config["output_directory"][0], "model_state_dict.pt"))
-   
+   write_yml_file(config = config, 
+                  out_file=Path(config["output_directory"][0], "best_config.yml"))
    #-----------------------------------------------------------------------------#
    #                   Incase you close this file and open again,                #
    #                    you can load your data, model as follows                 #
@@ -93,7 +95,7 @@ The configuration file ``config.yml`` and data for this example can be found `he
                                          "model_state_dict.pt")))
    
    data = torch.load(Path(config["output_directory"][0], "data.pt"))
-   
+
 
 Multiple outputs simulation
 ---------------------------
@@ -102,12 +104,11 @@ The configuration file ``config.yml`` and data for this example can be found `he
 
 .. code-block:: python
 
-   # Import hydroecolstm function
-   
    from hydroecolstm.model_run import run_config
    from hydroecolstm.utility.plot import plot
    from hydroecolstm.data.read_config import read_config
    from hydroecolstm.model.create_model import create_model
+   from hydroecolstm.interface.utility import write_yml_file
    from hydroecolstm.utility.evaluation_function import EvaluationFunction
    import matplotlib.pyplot as plt
    from pathlib import Path
@@ -151,14 +152,16 @@ The configuration file ``config.yml`` and data for this example can be found `he
    torch.save(data, Path(config["output_directory"][0], "data.pt"))
    torch.save(model.state_dict(), 
               Path(config["output_directory"][0], "model_state_dict.pt"))
+   write_yml_file(config = best_config, 
+                  out_file=Path(config["output_directory"][0], "best_config.yml"))
    
    #-----------------------------------------------------------------------------#
    #                   Incase you close this file and open again,                #
    #                    you can load your data, model as follows                 #
    #-----------------------------------------------------------------------------#
-   config = read_config("C:/hydroecolstm/examples/2_streamflow_isotope_simulation/config.yml")
+   config = read_config("C:/hydroecolstm/examples/2_streamflow_isotope_simulation/results/best_config.yml")
    model = create_model(config)
    model.load_state_dict(torch.load(Path(config["output_directory"][0], 
                                          "model_state_dict.pt")))
    data = torch.load(Path(config["output_directory"][0], "data.pt"))
-   
+

examples/1_streamflow_simulation/main.py

@@ -3,6 +3,7 @@
 from hydroecolstm.utility.plot import plot
 from hydroecolstm.data.read_config import read_config
 from hydroecolstm.model.create_model import create_model
+from hydroecolstm.interface.utility import write_yml_file
 from hydroecolstm.utility.evaluation_function import EvaluationFunction
 from hydroecolstm.data.read_data import read_forecast_data
 import matplotlib.pyplot as plt
@@ -72,7 +73,8 @@
 torch.save(data, Path(config["output_directory"][0], "data.pt"))
 torch.save(model.state_dict(), 
            Path(config["output_directory"][0], "model_state_dict.pt"))
-
+write_yml_file(config = config, 
+               out_file=Path(config["output_directory"][0], "best_config.yml"))
 #-----------------------------------------------------------------------------#
 #                   Incase you close this file and open again,                #
 #                    you can load your data, model as follows                 #

examples/2_streamflow_isotope_simulation/main.py

@@ -58,14 +58,4 @@
 model = create_model(config)
 model.load_state_dict(torch.load(Path(config["output_directory"][0], 
                                       "model_state_dict.pt")))
-data = torch.load(Path(config["output_directory"][0], "data.pt"))
-
-
-
-
-
-
-
-
-
-
+data = torch.load(Path(config["output_directory"][0], "data.pt"))