#3062 - rename identifier to discriminator

docs/source/configuration/agents.rst

@@ -103,7 +103,7 @@ Similar to action space, this is defined as a list of components from the :py:mo
 
 ``reward_components``
 ^^^^^^^^^^^^^^^^^^^^^
-
+TODO: update description
 A list of reward types from :py:mod:`primaite.game.agent.rewards.RewardFunction.rew_class_identifiers`
 
 e.g.

docs/source/configuration/simulation.rst

@@ -6,7 +6,7 @@
 ``simulation``
 ==============
 In this section the network layout is defined. This part of the config follows a hierarchical structure. Almost every component defines a ``ref`` field which acts as a human-readable unique identifier, used by other parts of the config, such as agents.
-
+# TODO: ref field is no longer real
 At the top level of the network are ``nodes``, ``links`` and ``airspace``.
 
 e.g.

docs/source/how_to_guides/extensible_actions.rst

@@ -20,7 +20,7 @@ Custom actions within PrimAITE must be a sub-class of `AbstractAction`, and cont
 
 #. ConfigSchema class
 
-#. Unique Identifier
+#. Unique discriminator
 
 #. `form_request` method.
 
@@ -31,14 +31,14 @@ ConfigSchema
 The ConfigSchema sub-class of the action must contain all `configurable` variables within the action, that would be specified within the environments configuration YAML file.
 
 
-Unique Identifier
+Unique discriminator
 #################
 
-When declaring a custom class, it must have a unique identifier string, that allows PrimAITE to generate the correct action when needed.
+When declaring a custom class, it must have a unique discriminator string, that allows PrimAITE to generate the correct action when needed.
 
 .. code:: Python
 
-    class CreateDirectoryAction(AbstractAction, identifier="node_folder_create")
+    class CreateDirectoryAction(AbstractAction, discriminator="node_folder_create")
 
         config: CreateDirectoryAction.ConfigSchema
 
@@ -58,7 +58,7 @@ When declaring a custom class, it must have a unique identifier string, that all
                     config.directory_name,
                 ]
 
-The above action would fail pydantic validation as the identifier "node_folder_create" is already used by the `NodeFolderCreateAction`, and would create a duplicate listing within `AbstractAction._registry`.
+The above action would fail pydantic validation as the discriminator "node_folder_create" is already used by the `NodeFolderCreateAction`, and would create a duplicate listing within `AbstractAction._registry`.
 
 
 form_request method

docs/source/how_to_guides/extensible_agents.rst

@@ -25,7 +25,7 @@ The core features that should be implemented in any new agent are detailed below
 
     .. code-block:: python
 
-        class ExampleAgent(AbstractAgent, identifier = "ExampleAgent"):
+        class ExampleAgent(AbstractAgent, discriminator = "ExampleAgent"):
             """An example agent for demonstration purposes."""
 
             config: "ExampleAgent.ConfigSchema" = Field(default_factory= lambda: ExampleAgent.ConfigSchema())
@@ -64,9 +64,9 @@ The core features that should be implemented in any new agent are detailed below
 			starting_host: "Server_1"
 
 
-#. **Identifiers**:
+#. **discriminators**:
 
-    All agent classes should have an ``identifier`` attribute, a unique kebab-case string, for when they are added to the base ``AbstractAgent`` registry. This is then specified in your configuration YAML, and used by PrimAITE to generate the correct Agent.
+    All agent classes should have an ``discriminator`` attribute, a unique kebab-case string, for when they are added to the base ``AbstractAgent`` registry. This is then specified in your configuration YAML, and used by PrimAITE to generate the correct Agent.
 
 Changes to YAML file
 ====================

docs/source/how_to_guides/extensible_rewards.rst

@@ -17,7 +17,7 @@ Reward classes are inherited from AbstractReward (a sub-class of Pydantic's Base
 Within the reward class there is a ConfigSchema class responsible for ensuring the config file data
 is in the correct format. This also means there is little (if no) requirement for and `__init__`
 method. The `.from_config` method is no longer required as it's inherited from `AbstractReward`.
-Each class requires an identifier string which is used by the ConfigSchema class to verify that it
+Each class requires an discriminator string which is used by the ConfigSchema class to verify that it
 hasn't previously been added to the registry.
 
 Inheriting from `BaseModel` removes the need for an `__init__` method but means that object
@@ -28,7 +28,7 @@ To add a new reward class follow the example below. Note that the type attribute
 
 .. code-block:: Python
 
-class DatabaseFileIntegrity(AbstractReward, identifier="DATABASE_FILE_INTEGRITY"):
+class DatabaseFileIntegrity(AbstractReward, discriminator="DATABASE_FILE_INTEGRITY"):
     """Reward function component which rewards the agent for maintaining the integrity of a database file."""
 
     config: "DatabaseFileIntegrity.ConfigSchema"

docs/source/node_sets.rst

@@ -82,7 +82,7 @@ Here is an example of creating a custom node adder, DataCenterAdder:
 
 .. code-block:: python
 
-    class DataCenterAdder(NetworkNodeAdder, identifier="data_center"):
+    class DataCenterAdder(NetworkNodeAdder, discriminator="data_center"):
         class ConfigSchema(NetworkNodeAdder.ConfigSchema):
             type: Literal["data_center"] = "data_center"
             num_servers: int