Upload of a new agent

README.md

@@ -0,0 +1,60 @@
+---
+tags:
+- CartPole-v1
+- reinforcement-learning
+- rl-framework
+model-index:
+- name: Imitation-BC-CartPole-v1
+  results:
+  - task:
+      type: reinforcement-learning
+      name: reinforcement-learning
+    dataset:
+      name: CartPole-v1
+      type: CartPole-v1
+    metrics:
+    - type: mean_reward
+      value: not evaluated
+      name: mean_reward
+      verified: false
+---
+
+
+# Custom implemented PPO agent playing on *CartPole-v1*
+
+This is a trained model of an agent playing on the environment *CartPole-v1*.
+The agent was trained with a PPO algorithm.
+See further agent and evaluation metadata in the according README section.
+
+
+## Import
+The Python module used for training and uploading/downloading is [rl-framework](https://github.com/alexander-zap/rl-framework).
+It is an easy-to-read, plug-and-use Reinforcement Learning framework and provides standardized interfaces
+and implementations to various Reinforcement Learning methods and environments.
+
+Also it provides connectors for the upload and download to popular model version control systems,
+including the HuggingFace Hub.
+
+## Usage
+```python
+
+from rl-framework import ImitationAgent, ImitationAlgorithm
+
+# Create new agent instance
+agent = ImitationAgent(
+    algorithm=ImitationAlgorithm.PPO
+    algorithm_parameters={
+        ...
+    },
+)
+
+# Download existing agent from HF Hub
+repository_id = "zap-thamm/Imitation-BC-CartPole-v1"
+file_name = "agent.pkl"
+agent.download(repository_id=repository_id, filename=file_name)
+
+```
+
+Further examples can be found in the [exploration section of the rl-framework repository](https://github.com/alexander-zap/rl-framework/tree/main/exploration).
+
+            

agent.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93adc2fb1d0e81df522c4a228190c3a589f256a3d4115a66949e82ceabec383a
+size 1473543

results.json

@@ -0,0 +1 @@
+{"env_id": "CartPole-v1", "datetime": "2024-11-14T14:33:23.999973", "mean_reward": 500.0, "std_reward": 0.0}

system.json

@@ -0,0 +1 @@
+{"OS": "Windows-10-10.0.19045-SP0 10.0.19045", "Python": "3.10.8", "Stable-Baselines3": "2.3.2", "PyTorch": "2.5.1+cpu", "GPU Enabled": "False", "Numpy": "1.26.4", "Cloudpickle": "3.1.0", "Gymnasium": "0.29.1", "OpenAI Gym": "0.26.2"}

training_metrics.json

@@ -0,0 +1 @@
+{}