dev: rename class name xNES -> XNES

EMI-Group · Sep 4, 2023 · d9fb0f1 · d9fb0f1
1 parent 6345aee
commit d9fb0f1
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/docs/source/api/algorithms/so/nes.rst b/docs/source/api/algorithms/so/nes.rst
@@ -2,7 +2,7 @@
 xNES
 ====
 
-.. autoclass:: evox.algorithms.xNES
+.. autoclass:: evox.algorithms.XNES
     :members:
 
 .. autoclass:: evox.algorithms.SeparableNES

diff --git a/src/evox/algorithms/so/es_variants/__init__.py b/src/evox/algorithms/so/es_variants/__init__.py
@@ -7,7 +7,7 @@
 from .esmc import ESMC
 from .guided_es import GuidedES
 from .ma_es import MAES, LMMAES
-from .nes import xNES, SeparableNES
+from .nes import XNES, SeparableNES
 from .noise_reuse_es import Noise_reuse_es
 from .open_es import OpenES
 from .persistent_es import PersistentES
@@ -24,4 +24,4 @@
     def LES(*args, **kwargs):
         raise ImportError(
             f'LES requires flax but got "{original_erorr_msg}" when importing'
-        )
+        )
diff --git a/src/evox/algorithms/so/es_variants/nes.py b/src/evox/algorithms/so/es_variants/nes.py
@@ -1,7 +1,7 @@
 # --------------------------------------------------------------------------------------
 # This code implements algorithms described in the following papers:
 #
-# Title: Exponential Natural Evolution Strategies (xNES)
+# Title: Exponential Natural Evolution Strategies (XNES)
 # Link: https://dl.acm.org/doi/abs/10.1145/1830483.1830557
 #
 # Title: Natural Evolution Strategies (SeparableNES)

diff --git a/src/evox/algorithms/so/es_variants/open_es.py b/src/evox/algorithms/so/es_variants/open_es.py
@@ -1,7 +1,7 @@
 # --------------------------------------------------------------------------------------
 # This code implements algorithms described in the following papers:
 #
-# Title: Exponential Natural Evolution Strategies (xNES)
+# Title: Exponential Natural Evolution Strategies (XNES)
 # Link: https://dl.acm.org/doi/abs/10.1145/1830483.1830557
 #
 # Title: Natural Evolution Strategies (SeparableNES)

diff --git a/tests/test_single_objective_algorithms.py b/tests/test_single_objective_algorithms.py
@@ -2,7 +2,7 @@
 import jax.numpy as jnp
 import pytest
 from evox import pipelines, problems
-from evox.algorithms import CMAES, SepCMAES, CSO, DE, PGPE, PSO, OpenES, xNES, CoDE, JaDE, SaDE, SHADE
+from evox.algorithms import CMAES, SepCMAES, CSO, DE, PGPE, PSO, OpenES, XNES, CoDE, JaDE, SaDE, SHADE
 from evox.monitors import StdSOMonitor
 from evox.utils import compose, rank_based_fitness
 
@@ -98,7 +98,7 @@ def test_openes(optimizer):
 def test_xnes():
     init_mean = jnp.array([5.0, -10, 15, -20, 25])
     init_covar = jnp.eye(5) * 2
-    algorithm = xNES(init_mean, init_covar, pop_size=100)
+    algorithm = XNES(init_mean, init_covar, pop_size=100)
     fitness = run_single_objective_algorithm(algorithm)
     assert fitness < 0.1