Update versioning system (#252)

* Draft for new versioning scheme

* Update build system

* Testing file

* Fix build error

* Use build

* Python version

* Importlib in Python 3.8

* Add back requirements_test.txt

* Rename

* Bad torch version

* Delete version file

* Ignore version

* No need to build

* Delete test requirements

* Apply isort

* Fix Python version

Author: mmuckley

.flake8

@@ -15,7 +15,7 @@ jobs:
       max-parallel: 4
       matrix:
         platform: [ubuntu-latest]
-        python-version: [3.7, 3.8]
+        python-version: [3.8]
 
     runs-on: ${{ matrix.platform }}
 
@@ -28,8 +28,9 @@ jobs:
       - name: Install
         run: |
           python -m pip install --upgrade pip
-          pip install --upgrade wheel
-          pip install -e .
+          pip install --upgrade wheel build setuptools
+          python -m build .
+          pip install dist/*.whl
       - name: Test Import
         run: |
           python -c 'import fastmri'
@@ -40,7 +41,7 @@ jobs:
       max-parallel: 4
       matrix:
         platform: [ubuntu-latest]
-        python-version: [3.7, 3.8]
+        python-version: [3.8]
 
     runs-on: ${{ matrix.platform }}
 
@@ -65,7 +66,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install --upgrade wheel
-          pip install -r dev-requirements.txt
+          pip install --editable ".[tests]"
       - name: Check Formatting and Lint
         run: |
           python --version
@@ -75,10 +76,8 @@ jobs:
           mypy fastmri
           flake8 --version
           flake8 fastmri_examples fastmri tests
-      - name: Install fastMRI
-        run: |
-          python setup.py bdist_wheel
-          pip install dist/*.whl
+          isort --version
+          isort --check-only fastmri tests fastmri_examples
       - name: Run pytest
         run: |
           echo -e "PyTorch \c" && pip show torch | grep Version 

.github/workflows/build-and-test.yml

@@ -20,3 +20,4 @@ lightning_logs/
 *.pt
 build/
 dist/
+fastmri/_version.py

.gitignore

@@ -54,7 +54,8 @@ help(SliceDataset)
 
 **Note:** Contributions to the code are continuously tested via GitHub actions.
 If you encounter an issue, the best first thing to do is to try to match the
-test environments in `requirements.txt` and `dev-requirements.txt`.
+`tests` environment in `setup.cfg`, e.g., `pip install --editable ".[tests]"`
+when installing from source.
 
 **Note:** As documented in [Issue 215](https://github.com/facebookresearch/fastMRI/issues/215),
 there is currently a memory leak when using `h5py` installed from `pip` and

README.md

@@ -5,14 +5,16 @@
 LICENSE file in the root directory of this source tree.
 """
 
-__version__ = "0.1.2a20220121"
-__author__ = "Facebook/NYU fastMRI Team"
-__author_email__ = "fastmri@fb.com"
-__license__ = "MIT"
-__homepage__ = "https://fastmri.org/"
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("fastmri")
+except PackageNotFoundError:
+    # package is not installed
+    import warnings
+
+    warnings.warn("Could not retrieve fastmri version!")
 
-import torch
-from packaging import version
 
 from .coil_combine import rss, rss_complex
 from .fftc import fft2c_new as fft2c

dev-requirements.txt

@@ -23,7 +23,7 @@ def rss(data: torch.Tensor, dim: int = 0) -> torch.Tensor:
     Returns:
         The RSS value.
     """
-    return torch.sqrt((data ** 2).sum(dim))
+    return torch.sqrt((data**2).sum(dim))
 
 
 def rss_complex(data: torch.Tensor, dim: int = 0) -> torch.Tensor:

fastmri/__init__.py

@@ -5,5 +5,5 @@
 LICENSE file in the root directory of this source tree.
 """
 
-from .mri_data import SliceDataset, CombinedSliceDataset
+from .mri_data import CombinedSliceDataset, SliceDataset
 from .volume_sampler import VolumeSampler

fastmri/coil_combine.py

@@ -276,8 +276,8 @@ def __init__(
             if dataset_cache.get(root) is None and use_dataset_cache:
                 dataset_cache[root] = self.examples
                 logging.info(f"Saving dataset cache to {self.dataset_cache_file}.")
-                with open(self.dataset_cache_file, "wb") as f:
-                    pickle.dump(dataset_cache, f)
+                with open(self.dataset_cache_file, "wb") as cache_f:
+                    pickle.dump(dataset_cache, cache_f)
         else:
             logging.info(f"Using dataset cache from {self.dataset_cache_file}.")
             self.examples = dataset_cache[root]

fastmri/data/__init__.py

@@ -7,10 +7,11 @@
 
 from typing import Dict, NamedTuple, Optional, Sequence, Tuple, Union
 
-import fastmri
 import numpy as np
 import torch
 
+import fastmri
+
 from .subsample import MaskFunc