fix naming

ivukotic · Aug 4, 2020 · 631ad3c · 631ad3c
1 parent 3f90145
commit 631ad3c
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
-# gym_cache
+# gym-cache
 OpenAI based Gym environments for training RL caching agent
 
 install it:
 <code>
-   pip install gym_cache
+   pip install gym-cache
 </code> 
 
 import it like this:
@@ -63,7 +63,7 @@ To change environments:
    or
    <code>
    python setup.py bdist_wheel
-   python -m pip install dist\gym_cache-1.0.0-py3-none-any.whl
+   python -m pip install dist\gym_cache-1.0.1-py3-none-any.whl
    </code> 
 * to upload to pypi repository
    <code>

diff --git a/TODO.md b/TODO.md
@@ -2,5 +2,4 @@
 add actor cleaning step: 
 * ask actor for decission to remove or not. List files in order of LRU. Signal to not learn is given in comment dict.
 
-register so it is pip installable.
 
diff --git a/check_conformity.py b/check_conformity.py
@@ -0,0 +1,8 @@
+from stable_baselines.common.env_checker import check_env
+
+# env = CustomEnv(arg1, ...)
+# env = gym.make('gym_cache:Cache-v0')
+env = CacheEnv()
+
+# It will check your custom environment and output additional warnings if needed
+check_env(env)
diff --git a/gym-cache/__init__.py → gym_cache/__init__.py b/gym-cache/__init__.py → gym_cache/__init__.py
diff --git a/gym-cache/envs/__init__.py → gym_cache/envs/__init__.py b/gym-cache/envs/__init__.py → gym_cache/envs/__init__.py
diff --git a/gym-cache/envs/cache_continous.py → gym_cache/envs/cache_continous.py b/gym-cache/envs/cache_continous.py → gym_cache/envs/cache_continous.py
diff --git a/gym-cache/envs/cache_env.py → gym_cache/envs/cache_env.py b/gym-cache/envs/cache_env.py → gym_cache/envs/cache_env.py
diff --git a/gym-cache/envs/cache_env_full.py → gym_cache/envs/cache_env_full.py b/gym-cache/envs/cache_env_full.py → gym_cache/envs/cache_env_full.py
diff --git a/requirements.txt b/requirements.txt
@@ -3,4 +3,5 @@ wheel
 tqdm
 twine
 pandas
-gym
+gym
+stable_baselines
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='gym_cache',
-    version='1.0.1',
+    version='1.0.2',
     install_requires=[
         'gym>=0.2.3',
         'pandas>=0.24.2',
@@ -17,7 +17,7 @@
     description="gym environment simulating file cache.",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/ivukotic/gym_cache",
+    url="https://github.com/ivukotic/gym-cache",
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,5 +2,4 @@
		add actor cleaning step:
		* ask actor for decission to remove or not. List files in order of LRU. Signal to not learn is given in comment dict.

		register so it is pip installable.
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,4 +3,5 @@ wheel @@
     tqdm
     twine
     pandas
-    gym
+    gym
+    stable_baselines