{
 "cells": [
  {
   "cell_type": "raw",
   "id": "3332caa6",
   "metadata": {},
   "source": [
    "---\n",
    "summary: Import Yera and Explore your Models\n",
    "title: Import Yera\n",
    "---"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "f94c70eb",
   "metadata": {},
   "source": [
    "At the end of this tutorial you'll have been introduced to Yera's single-import\n",
    "design and how to explore your available models via the model atlases.\n",
    "\n",
    "## Import\n",
    "\n",
    "Yera is designed so its entire Python API lives behind a single import. Just import\n",
    "yera\n",
    "\n",
    "```Python\n",
    "import yera as yr\n",
    "```\n",
    "\n",
    "We conventionally alias it as `yr`. This will be used through the rest of the docs.\n",
    "\n",
    "That's it. `yr` is the entry point for everything you want to use.\n",
    "If you inspect it with tab completion or `dir(yr)` you'll see a whole bunch of stuff.\n",
    "We'll work our way through them throughout these tutorials, but I'd like to draw\n",
    "your attention to one of them in particular.\n",
    "\n",
    "## Model Atlases\n",
    "\n",
    "Yera contains model atlases at the top-level import. For now the only one there is\n",
    "the one containing all your LLMs, but in future Yera will support various other\n",
    "models types such as text-to-speech, speech-to-text, embeddings and more.\n",
    "\n",
    "An atlas is the means by which you explore and use models in your Yera apps.\n",
    "It contains all the models available to your current profile.\n",
    "Try printing `yr.llm`"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "id": "f1132edc",
   "metadata": {},
   "outputs": [],
   "source": [
    "print(yr.llm)"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "edafe204",
   "metadata": {},
   "source": [
    "and you should see like this\n",
    "\n",
    "```\n",
    "┌─[llm]\n",
    "\n",
    "├─ Default: ollama.gemma4.gemma4-31b\n",
    "\n",
    "│\n",
    "\n",
    "├── anthropic/\n",
    "\n",
    "│   └── ...\n",
    "\n",
    "├── ollama/\n",
    "\n",
    "│   ├── gemma4/\n",
    "\n",
    "│   │   └── gemma4-31b\n",
    "\n",
    "│   └── ...\n",
    "\n",
    "└── openai/\n",
    "\n",
    "└── ...\n",
    "```\n",
    "\n",
    "showing the different providers and the models available in them as well as your\n",
    "configured default.\n",
    "\n",
    "The models and groupings all live as attributes on the atlas. Have an explore to see what you can use.\n",
    "\n",
    "We'll come to how to use models via atlases at a later tutorial, just note that your\n",
    "configured default will be what the apps you build will run with.\n",
    "\n",
    "## Summary\n",
    "\n",
    "You now know about the Yera top-level import, its design and the LLM model atlas.\n",
    "In the next tutorial you'll build your first app."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "name": "python"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 5
}