Skip to content

Commit

Permalink
Add docstrings to clarify submodule intended usage
Browse files Browse the repository at this point in the history
  • Loading branch information
NeonDaniel committed Dec 18, 2024
1 parent 11f194c commit ca32adc
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 0 deletions.
4 changes: 4 additions & 0 deletions neon_data_models/models/api/http/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

from neon_data_models.models.api.http.brainforge import *

"""
This module contains models for interacting via HANA (HTTP).
"""
4 changes: 4 additions & 0 deletions neon_data_models/models/api/mq/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,7 @@

from neon_data_models.models.api.mq.llm import *
from neon_data_models.models.api.mq.users import *

"""
This module contains models for interacting via the MQ bus.
"""
5 changes: 5 additions & 0 deletions neon_data_models/models/api/node_v1/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@
from neon_data_models.models.base.messagebus import BaseMessage, MessageContext


"""
This module contains models for interacting via the Node socket (WS).
"""


class AudioInputData(BaseModel):
audio_data: str = Field(description="base64-encoded audio")
lang: str = Field(description="BCP-47 language code")
Expand Down

0 comments on commit ca32adc

Please sign in to comment.