Source code for omnisafe.models.actor.gaussian_actor

# Copyright 2022-2023 OmniSafe Team. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ==============================================================================
"""This module contains some base normal distribution agent for the models."""

from abc import ABC, abstractmethod

from omnisafe.models.base import Actor


class GaussianActor(Actor, ABC):
    """A abstract class for normal distribution actor.

    A NormalActor inherits from Actor and use Normal distribution to approximate
    the policy function.

    .. note::
        You can use this class to implement your own actor by inheriting it.
    """

    @property
    @abstractmethod
    def std(self) -> float:
        """Get the standard deviation of the normal distribution."""

    @std.setter
    @abstractmethod
    def std(self, std: float) -> None:
        """Set the standard deviation of the normal distribution."""