Update documentation and CI configuration: standardize test paths and enhance clarity

Author: chaoming0625

.github/PULL_REQUEST_TEMPLATE.md

@@ -45,7 +45,7 @@ See CONTRIBUTING.md for guidelines.
 ## Testing
 
 **How has this been tested?**
-<!-- Describe the tests_version2 you ran to verify your changes -->
+<!-- Describe the tests you ran to verify your changes -->
 
 ```python
 # Example test code or commands used

.github/labeler.yml

@@ -19,7 +19,7 @@ dependencies:
 # Tests
 tests:
   - changed-files:
-    - any-glob-to-any-file: ['tests_version2/**/*', '**/*test*.py']
+    - any-glob-to-any-file: ['tests/**/*', '**/*test*.py']
 
 # Examples
 examples:

.github/workflows/CI-models.yml

@@ -37,7 +37,7 @@ jobs:
           pip install -e .
       - name: Test with pytest
         run: |
-          pytest tests_version2/
+          pytest tests/
 
   test_macos:
     runs-on: macos-latest
@@ -59,7 +59,7 @@ jobs:
           pip install -e .
       - name: Test with pytest
         run: |
-          pytest tests_version2/
+          pytest tests/
 
   test_windows:
     runs-on: windows-latest
@@ -81,4 +81,4 @@ jobs:
           pip install -e .
       - name: Test with pytest
         run: |
-          pytest tests_version2/
+          pytest tests/

.github/workflows/CI.yml

@@ -1,4 +1,4 @@
-# This workflow will install Python dependencies, run tests_version2 and lint with a variety of Python versions
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
 name: Continuous Integration

CONTRIBUTING.md

@@ -114,12 +114,12 @@ Branch naming conventions:
 
 Run the test suite:
 ```bash
-pytest tests_version2/
+pytest tests/
 ```
 
 Run specific tests:
 ```bash
-pytest tests_version2/test_specific.py -v
+pytest tests/test_specific.py -v
 ```
 
 ### 4. Commit Your Changes
@@ -203,7 +203,7 @@ def simulate_network(network, duration, dt=0.1):
 
 Aim for high test coverage on new code:
 ```bash
-pytest --cov=brainpy tests_version2/
+pytest --cov=brainpy tests/
 ```
 
 ## Documentation

brainpy/math/einops_parsing.py

@@ -51,7 +51,7 @@ def __init__(self, expression: str, *, allow_underscore: bool = False,
         self.identifiers: Set[str] = set()
         # that's axes like 2, 3, 4 or 5. Axes with size 1 are exceptional and replaced with empty composition
         self.has_non_unitary_anonymous_axes: bool = False
-        # composition keeps structure of composite axes, see how different corner cases are handled in tests_version2
+        # composition keeps structure of composite axes, see how different corner cases are handled in tests
         self.composition: List[Union[List[str], str]] = []
         if '.' in expression:
             if '...' not in expression:

brainpy/math/tests/test_einops.py

@@ -118,7 +118,7 @@ def test_rearrange_consistency_numpy():
 
 
 def test_rearrange_permutations_numpy():
-    # tests_version2 random permutation of axes against two independent numpy ways
+    # tests random permutation of axes against two independent numpy ways
     for n_axes in range(1, 10):
         input = numpy.arange(2 ** n_axes).reshape([2] * n_axes)
         permutation = numpy.random.permutation(n_axes)

brainpy/math/tests/test_environment.py

@@ -21,7 +21,7 @@
 
 class TestEnvironment(unittest.TestCase):
     def test_numpy_func_return(self):
-        # Reset random state to ensure clean state between tests_version2
+        # Reset random state to ensure clean state between tests
         bm.random.seed()
 
         with bm.environment(numpy_func_return='jax_array'):

brainpy/math/tests/test_numpy_einsum.py

@@ -236,7 +236,7 @@ def test_tf_unsupported_3(self):
         s = 'ij,ij,jk->ik'
         self._check(s, x, y, z)
 
-    # these tests_version2 are based on https://github.com/dask/dask/pull/3412/files
+    # these tests are based on https://github.com/dask/dask/pull/3412/files
     @parameterized.named_parameters(
         {"testcase_name": "_{}_dtype={}".format(einstr, dtype.__name__), "einstr": einstr,
          "dtype": dtype}

brainpy/math/tests/test_numpy_ops.py

@@ -337,7 +337,7 @@ def op_record(name, nargs, dtypes, shapes, rng_factory, diff_modes,
     # TODO(phawkins): np.unwrap does not correctly promote its default period
     # argument under NumPy 1.21 for bfloat16 inputs. It works fine if we
     # explicitly pass a bfloat16 value that does not need promition. We should
-    # probably add a custom test harness for unwrap that tests_version2 the period
+    # probably add a custom test harness for unwrap that tests the period
     # argument anyway.
     op_record("unwrap", 1, [t for t in float_dtypes if t != dtypes.bfloat16],
               nonempty_nonscalar_array_shapes,
@@ -539,7 +539,7 @@ def _promote_like_jnp(fun, inexact=False):
     """Decorator that promotes the arguments of `fun` to `jnp.result_type(*args)`.
 
   jnp and np have different type promotion semantics; this decorator allows
-  tests_version2 make an np reference implementation act more like an jnp
+  tests make an np reference implementation act more like an jnp
   implementation.
   """
     _promote = _promote_dtypes_inexact if inexact else _promote_dtypes
@@ -3056,7 +3056,7 @@ def testIdentity(self, n, dtype):
         for left in [None, 0]
         for right in [None, 1]
         for dtype in default_dtypes
-        # following types lack precision for meaningful tests_version2
+        # following types lack precision for meaningful tests
         if dtype not in [np.int8, np.int16, np.float16, jnp.bfloat16]
     ))
     def testInterp(self, shape, dtype, period, left, right):
@@ -3562,7 +3562,7 @@ def testHistogramBinEdges(self, shape, dtype, bins, range, weights):
         for shape in [(5,), (5, 5)]
         for dtype in default_dtypes
         # We only test explicit integer-valued bin edges because in other cases
-        # rounding errors lead to flaky tests_version2.
+        # rounding errors lead to flaky tests.
         for bins in [np.arange(-5, 6), np.array([-5, 0, 3])]
         for density in [True, False]
         for weights in [True, False]
@@ -5108,7 +5108,7 @@ def testLongLong(self):
     @jtu.ignore_warning(category=UserWarning,
                         message="Explicitly requested dtype.*")
     def testArange(self):
-        # test cases inspired by dask tests_version2 at
+        # test cases inspired by dask tests at
         # https://github.com/dask/dask/blob/main/dask/array/tests/test_creation.py#L92
         np_arange = jtu.with_jax_dtype_defaults(np.arange)
         self.assertAllClose(bm.arange(77).value,
@@ -5777,7 +5777,7 @@ def testDisableNumpyRankPromotionBroadcasting(self):
             FLAGS.jax_numpy_rank_promotion = prev_flag
 
     def testStackArrayArgument(self):
-        # tests_version2 https://github.com/google/jax/issues/1271
+        # tests https://github.com/google/jax/issues/1271
         @jax.jit
         def foo(x):
             return bm.stack(x)
@@ -6050,7 +6050,7 @@ def testFromString(self):
         self.assertArraysEqual(expected, actual)
 
 
-# Most grad tests_version2 are at the lax level (see lax_test.py), but we add some here
+# Most grad tests are at the lax level (see lax_test.py), but we add some here
 # as needed for e.g. particular compound ops of interest.
 
 GradTestSpec = collections.namedtuple(
@@ -6126,7 +6126,7 @@ def testOpGradSpecialValue(self, op, special_value, order):
                     atol={np.float32: 3e-3})
 
     def testSincGradArrayInput(self):
-        # tests_version2 for a bug almost introduced in #5077
+        # tests for a bug almost introduced in #5077
         jax.grad(lambda x: bm.sinc(x).sum())(jnp.arange(10.))  # doesn't crash
 
     def testTakeAlongAxisIssue1521(self):