@huggingface/tasks 0.0.3 → 0.0.4

package/src/question-answering/data.ts

@@ -5,65 +5,67 @@ const taskData: TaskDataCustom = {
 		{
 			// TODO write proper description
 			description: "A famous question answering dataset based on English articles from Wikipedia.",
-			id:          "squad_v2",
+			id: "squad_v2",
 		},
 		{
 			// TODO write proper description
 			description: "A dataset of aggregated anonymized actual queries issued to the Google search engine.",
-			id:          "natural_questions",
+			id: "natural_questions",
 		},
 	],
 	demo: {
 		inputs: [
 			{
-				label:   "Question",
+				label: "Question",
 				content: "Which name is also used to describe the Amazon rainforest in English?",
-				type:    "text",
+				type: "text",
 			},
 			{
-				label:   "Context",
+				label: "Context",
 				content: "The Amazon rainforest, also known in English as Amazonia or the Amazon Jungle",
-				type:    "text",
+				type: "text",
 			},
 		],
 		outputs: [
 			{
-				label:   "Answer",
+				label: "Answer",
 				content: "Amazonia",
-				type:    "text",
+				type: "text",
 			},
 		],
 	},
 	metrics: [
 		{
-			description: "Exact Match is a metric based on the strict character match of the predicted answer and the right answer. For answers predicted correctly, the Exact Match will be 1. Even if only one character is different, Exact Match will be 0",
-			id:          "exact-match",
+			description:
+				"Exact Match is a metric based on the strict character match of the predicted answer and the right answer. For answers predicted correctly, the Exact Match will be 1. Even if only one character is different, Exact Match will be 0",
+			id: "exact-match",
 		},
 		{
-			description: " The F1-Score metric is useful if we value both false positives and false negatives equally. The F1-Score is calculated on each word in the predicted sequence against the correct answer",
-			id:          "f1",
+			description:
+				" The F1-Score metric is useful if we value both false positives and false negatives equally. The F1-Score is calculated on each word in the predicted sequence against the correct answer",
+			id: "f1",
 		},
 	],
 	models: [
 		{
 			description: "A robust baseline model for most question answering domains.",
-			id:          "deepset/roberta-base-squad2",
+			id: "deepset/roberta-base-squad2",
 		},
 		{
 			description: "A special model that can answer questions from tables!",
-			id:          "google/tapas-base-finetuned-wtq",
+			id: "google/tapas-base-finetuned-wtq",
 		},
 	],
-	spaces:       [
+	spaces: [
 		{
 			description: "An application that can answer a long question from Wikipedia.",
-			id:          "deepset/wikipedia-assistant",
+			id: "deepset/wikipedia-assistant",
 		},
 	],
-	summary:      "Question Answering models can retrieve the answer to a question from a given text, which is useful for searching for an answer in a document. Some question answering models can generate answers without context!",
+	summary:
+		"Question Answering models can retrieve the answer to a question from a given text, which is useful for searching for an answer in a document. Some question answering models can generate answers without context!",
 	widgetModels: ["deepset/roberta-base-squad2"],
-	youtubeId:    "ajPx5LwJD-I",
+	youtubeId: "ajPx5LwJD-I",
 };
 
-
 export default taskData;

package/src/reinforcement-learning/about.md

@@ -1,176 +1,167 @@
-## Use Cases
-
-### Gaming
-
-Reinforcement learning is known for its application to video games. Since the games provide a safe environment for the agent to be trained in the sense that it is perfectly defined and controllable, this makes them perfect candidates for experimentation and will help a lot to learn about the capabilities and limitations of various RL algorithms. 
-
-
-There are many videos on the Internet where a game-playing reinforcement learning agent starts with a terrible gaming strategy due to random initialization of its settings, but over iterations, the agent gets better and better with each episode of the training. This [paper](https://arxiv.org/abs/1912.10944) mainly investigates the performance of RL in popular games such as Minecraft or Dota2. The agent's performance can exceed a human player's, although there are still some challenges mainly related to efficiency in constructing the gaming policy of the reinforcement learning agent.
-
-
-### Trading and Finance
-Reinforcement learning is the science to train computers to make decisions and thus has a novel use in trading and finance. All time-series models are helpful in predicting prices, volume and future sales of a product or a stock. Reinforcement based automated agents can decide to sell, buy or hold a stock. It shifts the impact of AI in this field to real time decision making rather than just prediction of prices. The glossary given below will clear some parameters to as to how we can train a model to take these decisions.
-
-
-
-## Task Variants 
-
-### Model Based RL
-In model based reinforcement learning techniques intend to create a model of the environment, learn the state transition probabilities and the reward function, to find the optimal action. Some typical examples for model based reinforcement learning algorithms are dynamic programming, value iteration and policy iteration.
-
-
-### Model Free RL
-In model free reinforcement learning, agent decides on optimal actions based on its experience in the environment and the reward it collects from it. This is one of the most commonly used algorithms beneficial in complex environments, where modeling of state transition probabilities and reward functions are difficult. Some of the examples of model free reinforcement learning are SARSA, Q-Learning, actor-critic and proximal policy optimization (PPO) algorithms.
-
-
-## Glossary
-
-<!-- ![RL Loop](https://huggingface.co/blog/assets/63_deep_rl_intro/RL_process.jpg "Agent Environment Interaction") TODO: Uncomment image for visual understanding if it fits within the page--> 
-
-
-**Agent:** The learner and the decision maker.
-
-
-**Environment:** The part of the world the agent interacts, comprising everything outside the agent.
-
-
-Observations and states are the information our agent gets from the environment. In the case of a video game, it can be a frame (a screenshot). In the case of the trading agent, it can be the value of a certain stock.
-
-
-**State:** Complete description of the state of the environment with no hidden information.
-
-
-**Observation:** Partial description of the state, in a partially observed environment.
-
-
-
-**Action:** The decision taken by the agent.
-
-**Reward:** The numerical feedback signal that the agent receives from the environment based on the chosen action.
-
-
-**Return:** Cumulative Reward.  In the simplest case, the return is the sum of the rewards.
-
-
-**Episode:** For some applications there is a natural notion of final time step.  In this case, there is a starting point and an ending point (a terminal state). This creates an episode: a list of States, Actions, Rewards, and new States. For instance, think about Chess: an episode begins at the initial board position and ends when the game is over.
-
-**Policy:** The Policy is the brain of the Agent, it’s the function that tells what action to take given the state. So it defines the agent’s behavior at a given time. Reinforcement learning methods specify how the agent’s policy is changed as a result of its experience.
-
-## Inference
-
-Inference in reinforcement learning differs from other modalities, in which there's a model and test data. In reinforcement learning, once you have trained an agent in an environment, you try to run the trained agent for additional steps to get the average reward. 
-
-A typical training cycle consists of gathering experience from the environment, training the agent, and running the agent on a test environment to obtain average reward. Below there's a snippet on how you can interact with the environment using the `gymnasium` library, train an agent using `stable-baselines3`, evalute the agent on test environment and infer actions from the trained agent.
-
-  
-```python
-# Here we are running 20 episodes of CartPole-v1 environment, taking random actions
-import gymnasium as gym
-
-env = gym.make("CartPole-v1")
-observation, info = env.reset()
-
-for _ in range(20):
-	action = env.action_space.sample() # samples random action from action sample space
-
-        # the agent takes the action 
-	observation, reward, terminated, truncated, info = env.step(action)
-
-
-# if the agent reaches terminal state, we reset the environment
-if terminated or truncated: 
-
-	print("Environment is reset")
-	observation = env.reset()
-
-env.close()
-```
-
-Below snippet shows how to train a PPO model on LunarLander-v2 environment using `stable-baselines3` library and saving the model
-```python
-from stable_baselines3 import PPO
-
-# initialize the environment
-
-env = gym.make("LunarLander-v2")
-
-# initialize the model
-
-model = PPO(policy = "MlpPolicy",
-			env = env,
-			n_steps = 1024,
-			batch_size = 64,
-			n_epochs = 4,
-			verbose = 1)
-
-# train the model for 1000 time steps
-model.learn(total_timesteps = 1000)
-
-# Saving the model in desired directory
-model_name = "PPO-LunarLander-v2"
-model.save(model_name)
-```
-Below code shows how to evaluate an agent trained using `stable-baselines3`
-```python
-# Loading a saved model and evaluating the model for 10 episodes
-from stable_baselines3.common.evaluation import evaluate_policy
-from stable_baselines3 import PPO
-
-
-env = gym.make("LunarLander-v2")
-# Loading the saved model
-model = PPO.load("PPO-LunarLander-v2",env=env)
-
-# Initializating the evaluation environment
-eval_env = gym.make("LunarLander-v2")
-
-# Running the trained agent on eval_env for 10 time steps and getting the mean reward
-mean_reward, std_reward = evaluate_policy(model, eval_env, n_eval_episodes = 10,
-										  deterministic=True)
-
-print(f"mean_reward={mean_reward:.2f} +/- {std_reward}")
-```
-
-Below code snippet shows how to infer actions from an agent trained using `stable-baselines3`
-
-```python
-from stable_baselines3.common.evaluation import evaluate_policy
-from stable_baselines3 import PPO
-
-# Loading the saved model
-model = PPO.load("PPO-LunarLander-v2",env=env)
-
-# Getting the environment from the trained agent
-env = model.get_env()
-
-obs = env.reset()
-for i in range(1000):
-	# getting action predictions from the trained agent
-	action, _states = model.predict(obs, deterministic=True)
-	
-	# taking the predicted action in the environment to observe next state and rewards
-    obs, rewards, dones, info = env.step(action)
-```
-
-For more information, you can check out the documentations of the respective libraries.
-
-[Gymnasium Documentation](https://gymnasium.farama.org/)
-[Stable Baselines Documentation](https://stable-baselines3.readthedocs.io/en/master/)
-
-## Useful Resources
-
-Would you like to learn more about the topic? Awesome! Here you can find some curated resources that you may find helpful!
-
-- [HuggingFace Deep Reinforcement Learning Class](https://github.com/huggingface/deep-rl-class)
-- [Introduction to Deep Reinforcement Learning](https://huggingface.co/blog/deep-rl-intro)
-- [Stable Baselines Integration with HuggingFace](https://huggingface.co/blog/sb3)
-- Learn how reinforcement learning is used in conversational agents in this blog: [Illustrating Reinforcement Learning from Human Feedback (RLHF)](https://huggingface.co/blog/rlhf)
-- [Reinforcement Learning from Human Feedback From Zero to ChatGPT](https://www.youtube.com/watch?v=EAd4oQtEJOM)
-- [Guide on Multi-Agent Competition Systems](https://huggingface.co/blog/aivsai)
-
-### Notebooks
-- [Train a Deep Reinforcement Learning lander agent to land correctly on the Moon 🌕 using Stable-Baselines3](https://github.com/huggingface/deep-rl-class/blob/main/notebooks/unit1/unit1.ipynb)
-- [Introduction to Unity MLAgents](https://github.com/huggingface/deep-rl-class/blob/main/notebooks/unit5/unit5.ipynb)
-- [Training Decision Transformers with 🤗 transformers](https://github.com/huggingface/blog/blob/main/notebooks/101_train-decision-transformers.ipynb)
-
-This page was made possible thanks to the efforts of [Ram Ananth](https://huggingface.co/RamAnanth1), [Emilio Lehoucq](https://huggingface.co/emiliol), [Sagar Mathpal](https://huggingface.co/sagarmathpal) and [Osman Alenbey](https://huggingface.co/osman93).
+## Use Cases
+
+### Gaming
+
+Reinforcement learning is known for its application to video games. Since the games provide a safe environment for the agent to be trained in the sense that it is perfectly defined and controllable, this makes them perfect candidates for experimentation and will help a lot to learn about the capabilities and limitations of various RL algorithms.
+
+There are many videos on the Internet where a game-playing reinforcement learning agent starts with a terrible gaming strategy due to random initialization of its settings, but over iterations, the agent gets better and better with each episode of the training. This [paper](https://arxiv.org/abs/1912.10944) mainly investigates the performance of RL in popular games such as Minecraft or Dota2. The agent's performance can exceed a human player's, although there are still some challenges mainly related to efficiency in constructing the gaming policy of the reinforcement learning agent.
+
+### Trading and Finance
+
+Reinforcement learning is the science to train computers to make decisions and thus has a novel use in trading and finance. All time-series models are helpful in predicting prices, volume and future sales of a product or a stock. Reinforcement based automated agents can decide to sell, buy or hold a stock. It shifts the impact of AI in this field to real time decision making rather than just prediction of prices. The glossary given below will clear some parameters to as to how we can train a model to take these decisions.
+
+## Task Variants
+
+### Model Based RL
+
+In model based reinforcement learning techniques intend to create a model of the environment, learn the state transition probabilities and the reward function, to find the optimal action. Some typical examples for model based reinforcement learning algorithms are dynamic programming, value iteration and policy iteration.
+
+### Model Free RL
+
+In model free reinforcement learning, agent decides on optimal actions based on its experience in the environment and the reward it collects from it. This is one of the most commonly used algorithms beneficial in complex environments, where modeling of state transition probabilities and reward functions are difficult. Some of the examples of model free reinforcement learning are SARSA, Q-Learning, actor-critic and proximal policy optimization (PPO) algorithms.
+
+## Glossary
+
+<!-- ![RL Loop](https://huggingface.co/blog/assets/63_deep_rl_intro/RL_process.jpg "Agent Environment Interaction") TODO: Uncomment image for visual understanding if it fits within the page-->
+
+**Agent:** The learner and the decision maker.
+
+**Environment:** The part of the world the agent interacts, comprising everything outside the agent.
+
+Observations and states are the information our agent gets from the environment. In the case of a video game, it can be a frame (a screenshot). In the case of the trading agent, it can be the value of a certain stock.
+
+**State:** Complete description of the state of the environment with no hidden information.
+
+**Observation:** Partial description of the state, in a partially observed environment.
+
+**Action:** The decision taken by the agent.
+
+**Reward:** The numerical feedback signal that the agent receives from the environment based on the chosen action.
+
+**Return:** Cumulative Reward. In the simplest case, the return is the sum of the rewards.
+
+**Episode:** For some applications there is a natural notion of final time step. In this case, there is a starting point and an ending point (a terminal state). This creates an episode: a list of States, Actions, Rewards, and new States. For instance, think about Chess: an episode begins at the initial board position and ends when the game is over.
+
+**Policy:** The Policy is the brain of the Agent, it’s the function that tells what action to take given the state. So it defines the agent’s behavior at a given time. Reinforcement learning methods specify how the agent’s policy is changed as a result of its experience.
+
+## Inference
+
+Inference in reinforcement learning differs from other modalities, in which there's a model and test data. In reinforcement learning, once you have trained an agent in an environment, you try to run the trained agent for additional steps to get the average reward.
+
+A typical training cycle consists of gathering experience from the environment, training the agent, and running the agent on a test environment to obtain average reward. Below there's a snippet on how you can interact with the environment using the `gymnasium` library, train an agent using `stable-baselines3`, evalute the agent on test environment and infer actions from the trained agent.
+
+```python
+# Here we are running 20 episodes of CartPole-v1 environment, taking random actions
+import gymnasium as gym
+
+env = gym.make("CartPole-v1")
+observation, info = env.reset()
+
+for _ in range(20):
+	action = env.action_space.sample() # samples random action from action sample space
+
+        # the agent takes the action
+	observation, reward, terminated, truncated, info = env.step(action)
+
+
+# if the agent reaches terminal state, we reset the environment
+if terminated or truncated:
+
+	print("Environment is reset")
+	observation = env.reset()
+
+env.close()
+```
+
+Below snippet shows how to train a PPO model on LunarLander-v2 environment using `stable-baselines3` library and saving the model
+
+```python
+from stable_baselines3 import PPO
+
+# initialize the environment
+
+env = gym.make("LunarLander-v2")
+
+# initialize the model
+
+model = PPO(policy = "MlpPolicy",
+			env = env,
+			n_steps = 1024,
+			batch_size = 64,
+			n_epochs = 4,
+			verbose = 1)
+
+# train the model for 1000 time steps
+model.learn(total_timesteps = 1000)
+
+# Saving the model in desired directory
+model_name = "PPO-LunarLander-v2"
+model.save(model_name)
+```
+
+Below code shows how to evaluate an agent trained using `stable-baselines3`
+
+```python
+# Loading a saved model and evaluating the model for 10 episodes
+from stable_baselines3.common.evaluation import evaluate_policy
+from stable_baselines3 import PPO
+
+
+env = gym.make("LunarLander-v2")
+# Loading the saved model
+model = PPO.load("PPO-LunarLander-v2",env=env)
+
+# Initializating the evaluation environment
+eval_env = gym.make("LunarLander-v2")
+
+# Running the trained agent on eval_env for 10 time steps and getting the mean reward
+mean_reward, std_reward = evaluate_policy(model, eval_env, n_eval_episodes = 10,
+										  deterministic=True)
+
+print(f"mean_reward={mean_reward:.2f} +/- {std_reward}")
+```
+
+Below code snippet shows how to infer actions from an agent trained using `stable-baselines3`
+
+```python
+from stable_baselines3.common.evaluation import evaluate_policy
+from stable_baselines3 import PPO
+
+# Loading the saved model
+model = PPO.load("PPO-LunarLander-v2",env=env)
+
+# Getting the environment from the trained agent
+env = model.get_env()
+
+obs = env.reset()
+for i in range(1000):
+	# getting action predictions from the trained agent
+	action, _states = model.predict(obs, deterministic=True)
+
+	# taking the predicted action in the environment to observe next state and rewards
+    obs, rewards, dones, info = env.step(action)
+```
+
+For more information, you can check out the documentations of the respective libraries.
+
+[Gymnasium Documentation](https://gymnasium.farama.org/)
+[Stable Baselines Documentation](https://stable-baselines3.readthedocs.io/en/master/)
+
+## Useful Resources
+
+Would you like to learn more about the topic? Awesome! Here you can find some curated resources that you may find helpful!
+
+- [HuggingFace Deep Reinforcement Learning Class](https://github.com/huggingface/deep-rl-class)
+- [Introduction to Deep Reinforcement Learning](https://huggingface.co/blog/deep-rl-intro)
+- [Stable Baselines Integration with HuggingFace](https://huggingface.co/blog/sb3)
+- Learn how reinforcement learning is used in conversational agents in this blog: [Illustrating Reinforcement Learning from Human Feedback (RLHF)](https://huggingface.co/blog/rlhf)
+- [Reinforcement Learning from Human Feedback From Zero to ChatGPT](https://www.youtube.com/watch?v=EAd4oQtEJOM)
+- [Guide on Multi-Agent Competition Systems](https://huggingface.co/blog/aivsai)
+
+### Notebooks
+
+- [Train a Deep Reinforcement Learning lander agent to land correctly on the Moon 🌕 using Stable-Baselines3](https://github.com/huggingface/deep-rl-class/blob/main/notebooks/unit1/unit1.ipynb)
+- [Introduction to Unity MLAgents](https://github.com/huggingface/deep-rl-class/blob/main/notebooks/unit5/unit5.ipynb)
+- [Training Decision Transformers with 🤗 transformers](https://github.com/huggingface/blog/blob/main/notebooks/101_train-decision-transformers.ipynb)
+
+This page was made possible thanks to the efforts of [Ram Ananth](https://huggingface.co/RamAnanth1), [Emilio Lehoucq](https://huggingface.co/emiliol), [Sagar Mathpal](https://huggingface.co/sagarmathpal) and [Osman Alenbey](https://huggingface.co/osman93).

package/src/reinforcement-learning/data.ts

@@ -1,78 +1,75 @@
-import type { TaskDataCustom } from "../Types";
-
-const taskData: TaskDataCustom = {
-	datasets: [
-		{
-			description:
-				"A curation of widely used datasets for Data Driven Deep Reinforcement Learning (D4RL)",
-			id: "edbeeching/decision_transformer_gym_replay",
-		},
-	],
-	demo: {
-		inputs: [
-			{
-				label:   "State",
-				content: "Red traffic light, pedestrians are about to pass.",
-				type:    "text",
-			},
-		],
-		outputs: [
-			{
-				label:   "Action",
-				content: "Stop the car.",
-				type:    "text",
-			},
-			{
-				label:   "Next State",
-				content: "Yellow light, pedestrians have crossed.",
-				type:    "text",
-			},
-		],
-	},
-	metrics: [
-		{
-			description:
-				"Accumulated reward across all time steps discounted by a factor that ranges between 0 and 1 and determines how much the agent optimizes for future relative to immediate rewards. Measures how good is the policy ultimately found by a given algorithm considering uncertainty over the future.",
-			id: "Discounted Total Reward",
-		},
-		{
-			description:
-				"Average return obtained after running the policy for a certain number of evaluation episodes. As opposed to total reward, mean reward considers how much reward a given algorithm receives while learning.",
-			id: "Mean Reward",
-		},
-		{
-			description:
-				"Measures how good a given algorithm is after a predefined time. Some algorithms may be guaranteed to converge to optimal behavior across many time steps. However, an agent that reaches an acceptable level of optimality after a given time horizon may be preferable to one that ultimately reaches optimality but takes a long time.",
-			id: "Level of Performance After Some Time",
-		},
-	],
-	models: [
-		{
-			description:
-				"A Reinforcement Learning model trained on expert data from the Gym Hopper environment",
-
-			id: "edbeeching/decision-transformer-gym-hopper-expert",
-		},
-		{
-			description:
-				"A PPO agent playing seals/CartPole-v0 using the stable-baselines3 library and the RL Zoo.",
-			id: "HumanCompatibleAI/ppo-seals-CartPole-v0",
-		},
-	],
-	spaces:  [
-		{
-			description: "An application for a cute puppy agent learning to catch a stick.",
-			id:          "ThomasSimonini/Huggy",
-		},
-		{
-			description: "An application to play Snowball Fight with a reinforcement learning agent.",
-			id:          "ThomasSimonini/SnowballFight",
-		},
-	],
-	summary:
-		"Reinforcement learning is the computational approach of learning from action by interacting with an environment through trial and error and receiving rewards (negative or positive) as feedback",
-	widgetModels: [],
-	youtubeId:    "q0BiUn5LiBc",
-};
-
-export default taskData;
+import type { TaskDataCustom } from "../Types";
+
+const taskData: TaskDataCustom = {
+	datasets: [
+		{
+			description: "A curation of widely used datasets for Data Driven Deep Reinforcement Learning (D4RL)",
+			id: "edbeeching/decision_transformer_gym_replay",
+		},
+	],
+	demo: {
+		inputs: [
+			{
+				label: "State",
+				content: "Red traffic light, pedestrians are about to pass.",
+				type: "text",
+			},
+		],
+		outputs: [
+			{
+				label: "Action",
+				content: "Stop the car.",
+				type: "text",
+			},
+			{
+				label: "Next State",
+				content: "Yellow light, pedestrians have crossed.",
+				type: "text",
+			},
+		],
+	},
+	metrics: [
+		{
+			description:
+				"Accumulated reward across all time steps discounted by a factor that ranges between 0 and 1 and determines how much the agent optimizes for future relative to immediate rewards. Measures how good is the policy ultimately found by a given algorithm considering uncertainty over the future.",
+			id: "Discounted Total Reward",
+		},
+		{
+			description:
+				"Average return obtained after running the policy for a certain number of evaluation episodes. As opposed to total reward, mean reward considers how much reward a given algorithm receives while learning.",
+			id: "Mean Reward",
+		},
+		{
+			description:
+				"Measures how good a given algorithm is after a predefined time. Some algorithms may be guaranteed to converge to optimal behavior across many time steps. However, an agent that reaches an acceptable level of optimality after a given time horizon may be preferable to one that ultimately reaches optimality but takes a long time.",
+			id: "Level of Performance After Some Time",
+		},
+	],
+	models: [
+		{
+			description: "A Reinforcement Learning model trained on expert data from the Gym Hopper environment",
+
+			id: "edbeeching/decision-transformer-gym-hopper-expert",
+		},
+		{
+			description: "A PPO agent playing seals/CartPole-v0 using the stable-baselines3 library and the RL Zoo.",
+			id: "HumanCompatibleAI/ppo-seals-CartPole-v0",
+		},
+	],
+	spaces: [
+		{
+			description: "An application for a cute puppy agent learning to catch a stick.",
+			id: "ThomasSimonini/Huggy",
+		},
+		{
+			description: "An application to play Snowball Fight with a reinforcement learning agent.",
+			id: "ThomasSimonini/SnowballFight",
+		},
+	],
+	summary:
+		"Reinforcement learning is the computational approach of learning from action by interacting with an environment through trial and error and receiving rewards (negative or positive) as feedback",
+	widgetModels: [],
+	youtubeId: "q0BiUn5LiBc",
+};
+
+export default taskData;