pygeai 0.6.0b7__py3-none-any.whl → 0.6.0b10__py3-none-any.whl

pygeai/_docs/source/conf.py

@@ -8,23 +8,45 @@
 
 import os
 import sys
+from datetime import datetime
+
 sys.path.insert(0, os.path.abspath('../..'))
 
+# Import version from package
+import pygeai
 
 project = 'PyGEAI'
-copyright = '2024, Globant'
 author = 'Globant'
-release = 'v0.1.1'
+copyright = f'{datetime.now().year}, {author}'
+release = pygeai.__version__
+version = '.'.join(release.split('.')[:2])  # e.g., '0.6' from '0.6.0'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc', 'sphinx_markdown_builder']
+extensions = [
+    'sphinx.ext.autodoc',       # Auto-generate docs from docstrings
+    'sphinx.ext.napoleon',      # Support for Google/NumPy style docstrings
+    'sphinx.ext.viewcode',      # Add links to source code
+    'sphinx.ext.intersphinx',   # Link to other project documentation
+    'sphinx.ext.autosummary',   # Generate summary tables
+    'sphinx_markdown_builder',  # Build markdown output
+]
 
 templates_path = ['_templates']
-exclude_patterns = []
+exclude_patterns = [
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+]
 
+# Language
+language = 'en'
 
+# Suppress specific warnings
+suppress_warnings = [
+    'ref.duplicate',  # Suppress duplicate implicit target warnings
+]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
@@ -32,14 +54,64 @@ exclude_patterns = []
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
-# Custom
+# Theme options
+html_theme_options = {
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': True,
+    'collapse_navigation': False,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False,
+}
+
+# HTML metadata
+html_title = f'{project} v{release} Documentation'
+html_short_title = f'{project} v{version}'
 html_show_sourcelink = False
 html_show_sphinx = False
 
+# -- Autodoc configuration ---------------------------------------------------
+
 autodoc_default_options = {
     'members': True,
-    'undoc-members': True,
+    'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': False,  # Hide undocumented members
+    'exclude-members': '__weakref__',
     'show-inheritance': True,
+    'inherited-members': False,
 }
 
+# Type hints configuration
+autodoc_typehints = 'description'
+autodoc_typehints_description_target = 'documented'
+
+# Mock imports for packages not available during build
 autodoc_mock_imports = []
+
+# -- Intersphinx configuration -----------------------------------------------
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'requests': ('https://requests.readthedocs.io/en/latest/', None),
+}
+
+# -- Napoleon configuration --------------------------------------------------
+
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = False
+napoleon_use_admonition_for_notes = False
+napoleon_use_admonition_for_references = False
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_preprocess_types = False
+napoleon_type_aliases = None
+napoleon_attr_annotations = True

pygeai/_docs/source/content/api_reference/embeddings.rst

@@ -28,13 +28,43 @@ Use the following command to generate embeddings:
     geai emb generate \
      -i "<your_text_input>" \
      -i "<your_image_input>" \
-     -m "<provider>/<model_name>"
+     -m "<provider>/<model_name>" \
+     --preview "1" \
+     --cache "0"
 
 Replace the placeholders with your desired values:
 
 * `<your_text_input>`: The text you want to generate an embedding for. For example: `"Help me with Globant Enterprise AI."`
 * `<your_image_input>`: The image data, encoded appropriately (e.g., base64). For example: `"image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAAEElEQVR4nGK6HcwNCAAA//8DTgE8HuxwEQAAAABJRU5ErkJggg=="`
 * `<provider>/<model_name>`: The provider and model to use for embedding generation. For example: `"awsbedrock/amazon.titan-embed-text-v1"`
+* `--preview`: Display mode for embeddings output. Use `"1"` to show embedding previews (first 5 values), or `"0"` to show full embedding vectors. Default: `"1"`
+* `--cache`: Enable or disable caching of embeddings. Use `"1"` to enable caching, or `"0"` to disable. Default: `"0"`
+
+**Additional Options:**
+
+* `--encoding-format`: Encoding format for embeddings (e.g., `"float"` or `"base64"`). Optional.
+* `--dimensions`: Number of dimensions for the embedding vector. Optional.
+* `--user`: User identifier for tracking purposes. Optional.
+* `--input-type`: Type of input being processed. Optional.
+* `--timeout`: Request timeout in seconds. Default: `600`
+
+**Example with preview output:**
+
+.. code-block:: shell
+
+    geai emb generate \
+     -i "Help me with Globant Enterprise AI" \
+     -m "awsbedrock/amazon.titan-embed-text-v1" \
+     --preview "1"
+
+**Example with full embeddings:**
+
+.. code-block:: shell
+
+    geai emb generate \
+     -i "Help me with Globant Enterprise AI" \
+     -m "awsbedrock/amazon.titan-embed-text-v1" \
+     --preview "0"
 
 
 Low level service layer