make release-tag: Merge branch 'main' into stable

Author: lajohn4747

CONTRIBUTING.rst

@@ -174,17 +174,17 @@ Release Workflow
 The process of releasing a new version involves several steps combining both ``git`` and
 ``bumpversion`` which, briefly:
 
-1. Merge what is in ``master`` branch into ``stable`` branch.
+1. Merge what is in ``main`` branch into ``stable`` branch.
 2. Update the version in ``setup.cfg``, ``deepecho/__init__.py`` and
    ``HISTORY.md`` files.
 3. Create a new git tag pointing at the corresponding commit in ``stable`` branch.
-4. Merge the new commit from ``stable`` into ``master``.
+4. Merge the new commit from ``stable`` into ``main``.
 5. Update the version in ``setup.cfg`` and ``deepecho/__init__.py``
    to open the next development iteration.
 
 .. note:: Before starting the process, make sure that ``HISTORY.md`` has been updated with a new
           entry that explains the changes that will be included in the new version.
-          Normally this is just a list of the Pull Requests that have been merged to master
+          Normally this is just a list of the Pull Requests that have been merged to main
           since the last release.
 
 Once this is done, run of the following commands:

HISTORY.md

@@ -1,5 +1,13 @@
 # History
 
+## 0.5.0 - 2023-11-13
+
+This release updates the PAR's model progress bar to show loss values and time elapsed (verbose option).
+
+### New Features
+* Update progress bar for PAR fitting - Issue [#80](https://github.com/sdv-dev/DeepEcho/issues/80) by @frances-h
+
+
 ## 0.4.2 - 2023-07-25
 
 This release drops support for Python 3.7 and adds support for Python 3.11.

INSTALL.md

@@ -47,12 +47,12 @@ make install
 
 If you intend to modify the source code or contribute to the project you will need to
 install it from the source using the `make install-develop` command. In this case, we
-recommend you to branch from `master` first:
+recommend you to branch from `main` first:
 
 ```bash
 git clone git@github.com:sdv-dev/DeepEcho
 cd DeepEcho
-git checkout master
+git checkout main
 git checkout -b <your-branch-name>
 make install-develp
 ```

Makefile

@@ -165,22 +165,22 @@ publish: dist publish-confirm ## package and upload a release
 	twine upload dist/*
 
 .PHONY: bumpversion-release
-bumpversion-release: ## Merge master to stable and bumpversion release
+bumpversion-release: ## Merge main to stable and bumpversion release
 	git checkout stable || git checkout -b stable
-	git merge --no-ff master -m"make release-tag: Merge branch 'master' into stable"
+	git merge --no-ff main -m"make release-tag: Merge branch 'main' into stable"
 	bumpversion release
 	git push --tags origin stable
 
 .PHONY: bumpversion-release-test
-bumpversion-release-test: ## Merge master to stable and bumpversion release
+bumpversion-release-test: ## Merge main to stable and bumpversion release
 	git checkout stable || git checkout -b stable
-	git merge --no-ff master -m"make release-tag: Merge branch 'master' into stable"
+	git merge --no-ff main -m"make release-tag: Merge branch 'main' into stable"
 	bumpversion release --no-tag
 	@echo git push --tags origin stable
 
 .PHONY: bumpversion-patch
-bumpversion-patch: ## Merge stable to master and bumpversion patch
-	git checkout master
+bumpversion-patch: ## Merge stable to main and bumpversion patch
+	git checkout main
 	git merge stable
 	bumpversion --no-tag patch
 	git push
@@ -199,7 +199,7 @@ bumpversion-major: ## Bump the version the next major skipping the release
 
 .PHONY: bumpversion-revert
 bumpversion-revert: ## Undo a previous bumpversion-release
-	git checkout master
+	git checkout main
 	git branch -D stable
 
 CLEAN_DIR := $(shell git status --short | grep -v ??)
@@ -213,10 +213,10 @@ ifneq ($(CLEAN_DIR),)
 	$(error There are uncommitted changes)
 endif
 
-.PHONY: check-master
-check-master: ## Check if we are in master branch
-ifneq ($(CURRENT_BRANCH),master)
-	$(error Please make the release from master branch\n)
+.PHONY: check-main
+check-main: ## Check if we are in main branch
+ifneq ($(CURRENT_BRANCH),main)
+	$(error Please make the release from main branch\n)
 endif
 
 .PHONY: check-candidate
@@ -232,7 +232,7 @@ ifeq ($(CHANGELOG_LINES),0)
 endif
 
 .PHONY: check-release
-check-release: check-clean check-candidate check-master check-history ## Check if the release can be made
+check-release: check-clean check-candidate check-main check-history ## Check if the release can be made
 	@echo "A new release can be made"
 
 .PHONY: release
@@ -242,7 +242,7 @@ release: check-release bumpversion-release publish bumpversion-patch
 release-test: check-release bumpversion-release-test publish-test bumpversion-revert
 
 .PHONY: release-candidate
-release-candidate: check-master publish bumpversion-candidate
+release-candidate: check-main publish bumpversion-candidate
 
 .PHONY: release-candidate-test
-release-candidate-test: check-clean check-master publish-test
+release-candidate-test: check-clean check-main publish-test

README.md

@@ -6,17 +6,17 @@
 
 [![Development Status](https://img.shields.io/badge/Development%20Status-2%20--%20Pre--Alpha-yellow)](https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha)
 [![PyPi Shield](https://img.shields.io/pypi/v/deepecho.svg)](https://pypi.python.org/pypi/deepecho)
-[![Tests](https://github.com/sdv-dev/DeepEcho/workflows/Run%20Tests/badge.svg)](https://github.com/sdv-dev/DeepEcho/actions?query=workflow%3A%22Run+Tests%22+branch%3Amaster)
+[![Tests](https://github.com/sdv-dev/DeepEcho/workflows/Run%20Tests/badge.svg)](https://github.com/sdv-dev/DeepEcho/actions?query=workflow%3A%22Run+Tests%22+branch%3Amain)
 [![Downloads](https://pepy.tech/badge/deepecho)](https://pepy.tech/project/deepecho)
-[![Coverage Status](https://codecov.io/gh/sdv-dev/DeepEcho/branch/master/graph/badge.svg)](https://codecov.io/gh/sdv-dev/DeepEcho)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/sdv-dev/DeepEcho/master?filepath=tutorials/timeseries_data)
+[![Coverage Status](https://codecov.io/gh/sdv-dev/DeepEcho/branch/main/graph/badge.svg)](https://codecov.io/gh/sdv-dev/DeepEcho)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/sdv-dev/DeepEcho/main?filepath=tutorials/timeseries_data)
 [![Slack](https://img.shields.io/badge/Slack%20Workspace-Join%20now!-36C5F0?logo=slack)](https://bit.ly/sdv-slack-invite)
 
 <div align="left">
 <br/>
 <p align="center">
 <a href="https://github.com/sdv-dev/DeepEcho">
-<img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/master/docs/images/DeepEcho-DataCebo.png"></img>
+<img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/DeepEcho-DataCebo.png"></img>
 </a>
 </p>
 </div>
@@ -49,12 +49,12 @@ time series**. It provides:
 [SDV Blog]: https://sdv.dev/blog
 [Documentation]: https://sdv.dev/SDV
 [Repository]: https://github.com/sdv-dev/DeepEcho
-[License]: https://github.com/sdv-dev/DeepEcho/blob/master/LICENSE
+[License]: https://github.com/sdv-dev/DeepEcho/blob/main/LICENSE
 [Development Status]: https://pypi.org/search/?c=Development+Status+%3A%3A+2+-+Pre-Alpha
-[Slack Logo]: https://github.com/sdv-dev/SDV/blob/master/docs/images/slack.png
+[Slack Logo]: https://github.com/sdv-dev/SDV/blob/stable/docs/images/slack.png
 [Community]: https://bit.ly/sdv-slack-invite
-[MyBinder Logo]: https://github.com/sdv-dev/SDV/blob/master/docs/images/mybinder.png
-[Tutorials]: https://mybinder.org/v2/gh/sdv-dev/DeepEcho/master?filepath=tutorials
+[MyBinder Logo]: https://github.com/sdv-dev/SDV/blob/stable/docs/images/mybinder.png
+[Tutorials]: https://mybinder.org/v2/gh/sdv-dev/DeepEcho/main?filepath=tutorials
 
 # Install
 
@@ -160,7 +160,7 @@ us developing new features or cool ideas!
 
 
 <div align="center">
-<a href="https://datacebo.com"><img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/master/docs/images/DataCebo.png"></img></a>
+<a href="https://datacebo.com"><img align="center" width=40% src="https://github.com/sdv-dev/SDV/blob/stable/docs/images/DataCebo.png"></img></a>
 </div>
 <br/>
 <br/>

deepecho/__init__.py

@@ -2,7 +2,7 @@
 
 __author__ = 'DataCebo, Inc.'
 __email__ = 'info@sdv.dev'
-__version__ = '0.4.2'
+__version__ = '0.5.0.dev1'
 __path__ = __import__('pkgutil').extend_path(__path__, __name__)
 
 from deepecho.demo import load_demo

deepecho/models/par.py

@@ -105,6 +105,7 @@ def __init__(self, epochs=128, sample_size=1, cuda=True, verbose=True):
 
         self.device = torch.device(device)
         self.verbose = verbose
+        self.loss_values = pd.DataFrame(columns=['Epoch', 'Loss'])
 
         LOGGER.info('%s instance created', self)
 
@@ -321,9 +322,13 @@ def fit_sequences(self, sequences, context_types, data_types):
         self._model = PARNet(self._data_dims, self._ctx_dims).to(self.device)
         optimizer = torch.optim.Adam(self._model.parameters(), lr=1e-3)
 
-        iterator = range(self.epochs)
+        iterator = tqdm(range(self.epochs), disable=(not self.verbose))
         if self.verbose:
-            iterator = tqdm(iterator)
+            pbar_description = 'Loss ({loss:.3f})'
+            iterator.set_description(pbar_description.format(loss=0))
+
+        # Reset loss_values dataframe
+        self.loss_values = pd.DataFrame(columns=['Epoch', 'Loss'])
 
         X_padded, seq_len = torch.nn.utils.rnn.pad_packed_sequence(X)
         for epoch in iterator:
@@ -333,8 +338,20 @@ def fit_sequences(self, sequences, context_types, data_types):
             optimizer.zero_grad()
             loss = self._compute_loss(X_padded[1:, :, :], Y_padded[:-1, :, :], seq_len)
             loss.backward()
+
+            epoch_loss_df = pd.DataFrame({
+                'Epoch': [epoch],
+                'Loss': [loss.item()]
+            })
+            if not self.loss_values.empty:
+                self.loss_values = pd.concat(
+                    [self.loss_values, epoch_loss_df]
+                ).reset_index(drop=True)
+            else:
+                self.loss_values = epoch_loss_df
+
             if self.verbose:
-                iterator.set_description(f'Epoch {epoch +1} | Loss {loss.item()}')
+                iterator.set_description(pbar_description.format(loss=loss.item()))
 
             optimizer.step()
 

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.4.2
+current_version = 0.5.0.dev1
 commit = True
 tag = True
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\.(?P<release>[a-z]+)(?P<candidate>\d+))?

setup.py

@@ -112,6 +112,6 @@
     test_suite='tests',
     tests_require=tests_require,
     url='https://github.com/sdv-dev/DeepEcho',
-    version='0.4.2',
+    version='0.5.0.dev1',
     zip_safe=False,
 )

tests/integration/test_par.py

@@ -35,6 +35,10 @@ def test_basic(self):
         model.fit_sequences(sequences, context_types, data_types)
         model.sample_sequence([])
 
+        # Assert
+        assert set(model.loss_values.columns) == {'Epoch', 'Loss'}
+        assert len(model.loss_values) == 128
+
     def test_conditional(self):
         """Test the ``PARModel`` with conditional sampling."""
         sequences = [
@@ -60,6 +64,10 @@ def test_conditional(self):
         model.fit_sequences(sequences, context_types, data_types)
         model.sample_sequence([0])
 
+        # Assert
+        assert set(model.loss_values.columns) == {'Epoch', 'Loss'}
+        assert len(model.loss_values) == 128
+
     def test_mixed(self):
         """Test the ``PARModel`` with mixed input data."""
         sequences = [
@@ -85,6 +93,10 @@ def test_mixed(self):
         model.fit_sequences(sequences, context_types, data_types)
         model.sample_sequence([0])
 
+        # Assert
+        assert set(model.loss_values.columns) == {'Epoch', 'Loss'}
+        assert len(model.loss_values) == 128
+
     def test_count(self):
         """Test the PARModel with datatype ``count``."""
         sequences = [
@@ -110,6 +122,10 @@ def test_count(self):
         model.fit_sequences(sequences, context_types, data_types)
         model.sample_sequence([0])
 
+        # Assert
+        assert set(model.loss_values.columns) == {'Epoch', 'Loss'}
+        assert len(model.loss_values) == 128
+
     def test_variable_length(self):
         """Test ``PARModel`` with variable data length."""
         sequences = [
@@ -134,3 +150,7 @@ def test_variable_length(self):
         model = PARModel()
         model.fit_sequences(sequences, context_types, data_types)
         model.sample_sequence([0])
+
+        # Assert
+        assert set(model.loss_values.columns) == {'Epoch', 'Loss'}
+        assert len(model.loss_values) == 128