fix: the python sdk lacks docstring documentation (#149)

* fix: clean doc

* fix: unify doc

* fix: async doc

* fix: refactor docstrings to abstract methods

* fix: remove unused import

* fix: revamp doc

* fix: imports helpers

* fix: imports helpers

* fix: add init to helpers module

Author: desaxce

literalai/__init__.py

@@ -1,6 +1,8 @@
 from literalai.client import AsyncLiteralClient, LiteralClient
 from literalai.evaluation.dataset import Dataset
 from literalai.evaluation.dataset_item import DatasetItem
+from literalai.evaluation.dataset_experiment import DatasetExperiment, DatasetExperimentItem
+from literalai.prompt_engineering.prompt import Prompt
 from literalai.my_types import *  # noqa
 from literalai.observability.generation import (
     BaseGeneration,
@@ -27,5 +29,8 @@
     "Dataset",
     "Attachment",
     "DatasetItem",
+    "DatasetExperiment",
+    "DatasetExperimentItem",
+    "Prompt",
     "__version__",
 ]

literalai/api/README.md

@@ -0,0 +1,7 @@
+# Literal AI API
+
+This module contains the APIs to directly interact with the Literal AI platform.
+
+`BaseLiteralAPI` has all the methods prototypes and is the source of truth when it comes to documentation.
+
+Inheriting from `BaseLiteralAPI` are `LiteralAPI` and `AsyncLiteralAPI`, the synchronous and asynchronous APIs respectively.