{"Package":"rollama","Title":"Communicate with 'Ollama' to Run Large Language Models Locally","Version":"0.2.0","Authors@R":"c(person(given = \"Johannes B.\",\nfamily = \"Gruber\",\nemail = \"JohannesB.Gruber@gmail.com\",\nrole = c(\"aut\", \"cre\"),\ncomment = c(ORCID = \"0000-0001-9177-1772\")),\nperson(given = \"Maximilian\",\nfamily = \"Weber\",\nrole = c(\"aut\", \"ctb\"),\ncomment = c(ORCID = \"0000-0002-1174-449X\")))","Description":"Wraps the 'Ollama' API, which can be used to\ncommunicate with generative large language models locally.","License":"GPL (>= 3)","Encoding":"UTF-8","RoxygenNote":"7.3.2","Imports":"callr, cli, dplyr, httr2, jsonlite, methods, prettyunits,\npurrr, rlang, tibble, withr","Suggests":"base64enc, covr, glue, knitr, rmarkdown, spelling, testthat\n(>= 3.0.0)","Depends":"R (>= 4.1.0)","VignetteBuilder":"knitr","Config/testthat/edition":"3","Language":"en-US","URL":"https://jbgruber.github.io/rollama/,\nhttps://github.com/JBGruber/rollama","BugReports":"https://github.com/JBGruber/rollama/issues","NeedsCompilation":"no","Packaged":"2024-12-06 15:05:40 UTC; johannes","Author":"Johannes B. Gruber [aut, cre] (),\nMaximilian Weber [aut, ctb] ()","Maintainer":"Johannes B. Gruber ","Repository":"CRAN","Date/Publication":"2024-12-06 15:20:02 UTC","repoType":"cran","tarballUrl":"ftp://cran.r-project.org/pub/R/src/contrib/rollama_0.2.0.tar.gz","jsonAuthors":[{"name":"Johannes B. Gruber","email":"JohannesB.Gruber@gmail.com","maintainer":true},{"name":"Maximilian Weber","email":null,"maintainer":false}],"readme":"\n\n\n# `rollama` $\"rollama-logo\"$ \n\n\n\n[![R-CMD-check](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/JBGruber/rollama/actions/workflows/R-CMD-check.yaml)\n[![Codecov test\ncoverage](https://codecov.io/gh/JBGruber/rollama/branch/main/graph/badge.svg)](https://app.codecov.io/gh/JBGruber/rollama?branch=main)\n[![CRAN\nstatus](https://www.r-pkg.org/badges/version/rollama)](https://CRAN.R-project.org/package=rollama)\n[![CRAN_Download_Badge](https://cranlogs.r-pkg.org/badges/grand-total/rollama)](https://cran.r-project.org/package=rollama)\n[![arXiv:10.48550/arXiv.2404.07654](https://img.shields.io/badge/DOI-arXiv.2404.07654-B31B1B?logo=arxiv)](https://doi.org/10.48550/arXiv.2404.07654)\n[![say-thanks](https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg)](https://saythanks.io/to/JBGruber)\n\n\nThe goal of `rollama` is to wrap the Ollama API, which allows you to run\ndifferent LLMs locally and create an experience similar to\nChatGPT/OpenAI’s API. Ollama is very easy to deploy and handles a huge\nnumber of models. Checkout the project here:\n.\n\n## Installation\n\nYou can install this package from CRAN:\n\n``` r\ninstall.packages(\"rollama\")\n```\n\nOr you can install the development version of `rollama` from\n[GitHub](https://github.com/JBGruber/rollama) with:\n\n``` r\n# install.packages(\"remotes\")\nremotes::install_github(\"JBGruber/rollama\")\n```\n\nHowever, `rollama` is just the client package. The models are run in\n`Ollama`, which you need to install on your system, on a remote system\nor through [Docker](https://docs.docker.com/desktop/). The easiest way\nis to simply download and install the Ollama application from [their\nwebsite](https://ollama.com/). Once `Ollama` is running, you can see if\nyou can access it with:\n\n``` r\nrollama::ping_ollama()\n#> ▶ Ollama (v0.3.12) is running at !\n```\n\n### Installation of Ollama through Docker\n\nThe advantage of running things through Docker is that the application\nis isolated from the rest of your system, behaves the same on different\nsystems, and is easy to download and update. You can also get a nice web\ninterface. After making sure [Docker](https://docs.docker.com/desktop/)\nis installed, you can simply use the Docker Compose file from [this\ngist](https://gist.github.com/JBGruber/73f9f49f833c6171b8607b976abc0ddc).\n\nIf you don’t know how to use Docker Compose, you can follow this video \nto use the compose file and start Ollama and Open WebUI:\n\n[![Install Docker on macOS, Windows and\nLinux](https://img.youtube.com/vi/iMyCdd5nP5U/0.jpg)](https://www.youtube.com/watch?v=iMyCdd5nP5U)\n\n## Example\n\nThe first thing you should do after installation is to pull one of the\nmodels from . By calling `pull_model()`\nwithout arguments, you are pulling the (current) default model —\n“llama3.1 8b”:\n\n``` r\nlibrary(rollama)\n```\n\n``` r\npull_model()\n```\n\nThere are two ways to communicate with the Ollama API. You can make\nsingle requests, which does not store any history and treats each query\nas the beginning of a new chat:\n\n``` r\n# ask a single question\nquery(\"why is the sky blue?\")\n#> \n#> ── Answer from llama3.1 ────────────────────────────────────────────────────────\n#> The sky appears blue to us because of a phenomenon called Rayleigh scattering.\n#> Here's a simplified explanation:\n#> \n#> 1. **Sunlight enters Earth's atmosphere**: When sunlight enters our atmosphere,\n#> it encounters tiny molecules of gases such as nitrogen (N2) and oxygen (O2).\n#> 2. **Scattering occurs**: These gas molecules are much smaller than the\n#> wavelength of light, so they scatter the shorter (blue) wavelengths more\n#> efficiently than the longer (red) wavelengths.\n#> 3. **Blue light is scattered in all directions**: As a result of this\n#> scattering, blue light is distributed throughout the atmosphere and reaches our\n#> eyes from all directions, giving the sky its blue appearance.\n#> 4. **Red light continues to travel in a straight line**: The longer wavelengths\n#> of red light, on the other hand, continue to travel in a straight line with\n#> less scattering, which is why we see them as coming from the sun itself.\n#> \n#> The combination of these factors results in our perception of a blue sky during\n#> the daytime. However, it's worth noting that:\n#> \n#> * **At sunrise and sunset**, the red light has a longer path through the\n#> atmosphere, so more scattering occurs, making the sky appear more reddish.\n#> * **On cloudy days** or during dust storms, the smaller particles in the air\n#> scatter all wavelengths of light equally, resulting in a hazy or whitish\n#> appearance.\n#> \n#> Now you know why the sky is blue!\n```\n\nOr you can use the `chat` function, treats all messages sent during an R\nsession as part of the same conversation:\n\n``` r\n# hold a conversation\nchat(\"why is the sky blue?\")\n#> \n#> ── Answer from llama3.1 ────────────────────────────────────────────────────────\n#> The sky appears blue to us because of a phenomenon called scattering, which\n#> occurs when sunlight enters Earth's atmosphere.\n#> \n#> Here's what happens:\n#> \n#> 1. **Sunlight**: The sun emits white light, which contains all the colors of\n#> the visible spectrum (red, orange, yellow, green, blue, indigo, and violet).\n#> 2. **Entry into atmosphere**: When this white light enters our atmosphere, it\n#> encounters tiny molecules of gases such as nitrogen (N2) and oxygen (O2). These\n#> molecules are much smaller than the wavelength of light.\n#> 3. **Scattering occurs**: As sunlight interacts with these molecules, the\n#> shorter (blue) wavelengths of light are scattered in all directions by the gas\n#> molecules. This is known as Rayleigh scattering, named after the British\n#> physicist Lord Rayleigh who first described it in the late 19th century.\n#> \n#> The key point here is that blue light is scattered more than other colors\n#> because its wavelength is so small compared to the size of the gas molecules.\n#> This means that the blue light is distributed throughout the atmosphere and\n#> reaches our eyes from all directions, making the sky appear blue!\n#> \n#> **Why not violet?**: If scattering was the only factor, we'd expect the sky to\n#> appear violet, as violet has an even shorter wavelength than blue. However,\n#> there are two reasons why we don't see a violet sky:\n#> \n#> a. **Color perception**: The human eye is less sensitive to violet light than\n#> to blue light, so we perceive the scattered light as blue rather than violet.\n#> \n#> b. **Atmospheric conditions**: The Earth's atmosphere absorbs and scatters\n#> shorter wavelengths of light more efficiently than longer ones. This is why the\n#> sun appears yellow or orange during sunrise and sunset, when the light has\n#> traveled through a greater thickness of atmosphere.\n#> \n#> So, to summarize: the sky appears blue because of the scattering of sunlight by\n#> tiny gas molecules in our atmosphere, which favors shorter (blue) wavelengths\n#> of light.\n```\n\n``` r\nchat(\"and how do you know that?\")\n#> \n#> ── Answer from llama3.1 ────────────────────────────────────────────────────────\n#> The explanation for why the sky is blue comes from a combination of scientific\n#> experiments, observations, and theoretical understanding. Here are some key\n#> sources and milestones:\n#> \n#> 1. **Rayleigh's work**: Lord Rayleigh (1842-1919) was a British physicist who,\n#> in 1871, first described the phenomenon of scattering by gases. He discovered\n#> that the blue color of the sky could be explained by the interaction between\n#> sunlight and the tiny molecules of air. Rayleigh's theory provided a foundation\n#> for understanding why shorter wavelengths are scattered more than longer ones.\n#> 2. **Tyndall's experiments**: In 1859, English physicist John Tyndall\n#> (1820-1893) conducted an experiment to demonstrate that gases can scatter\n#> light. He placed a container of water in a beam of sunlight and observed how\n#> the light was scattered by the water molecules. This experiment helped\n#> establish the concept of scattering.\n#> 3. **Arago's observations**: French physicist François Arago (1786-1853)\n#> noticed that the sky appears blue, even when viewed from a great distance,\n#> suggesting that the color is not simply a property of the atmosphere itself but\n#> rather an effect of the light being scattered by it.\n#> 4. **Modern understanding**: In the 20th century, scientists further refined\n#> our understanding of light scattering using various techniques such as\n#> spectroscopy and quantum mechanics.\n#> \n#> Some specific experiments and observations that confirm the explanation I\n#> provided include:\n#> \n#> * **Sunrise and sunset colors**: The color changes observed during sunrise and\n#> sunset demonstrate how different wavelengths are scattered at varying angles.\n#> * **Clouds and fog**: When sunlight passes through water droplets or ice\n#> crystals, it scatters in a way that appears as white light. This shows that\n#> shorter wavelengths (like blue) are being scattered more than longer ones.\n#> * **Light scattering measurements**: Researchers have measured the intensity of\n#> scattered light at different wavelengths using instruments such as\n#> spectrometers and spectrophotometers.\n#> \n#> These findings from various fields, including physics, chemistry, and\n#> astronomy, collectively support the explanation for why the sky appears blue.\n```\n\nIf you are done with a conversation and want to start a new one, you can\ndo that like so:\n\n``` r\nnew_chat()\n```\n\n## Model parameters\n\nYou can set a number of model parameters, either by creating a new\nmodel, with a\n[modelfile](https://jbgruber.github.io/rollama/reference/create_model.html),\nor by including the parameters in the prompt:\n\n``` r\nquery(\"why is the sky blue?\", model_params = list(\n seed = 42,\n temperature = 0,\n num_gpu = 0\n))\n#> \n#> ── Answer from llama3.1 ────────────────────────────────────────────────────────\n#> The sky appears blue to us because of a phenomenon called scattering, which\n#> occurs when sunlight interacts with the tiny molecules of gases in the\n#> atmosphere. Here's a simplified explanation:\n#> \n#> 1. **Sunlight enters Earth's atmosphere**: When the sun shines, it emits a wide\n#> range of electromagnetic radiation, including visible light, ultraviolet (UV)\n#> radiation, and infrared (IR) radiation.\n#> 2. **Light scatters off gas molecules**: As sunlight travels through the\n#> atmosphere, it encounters tiny molecules of gases like nitrogen (N2) and oxygen\n#> (O2). These molecules are much smaller than the wavelength of light, so they\n#> scatter the light in all directions.\n#> 3. **Short wavelengths scattered more**: The shorter wavelengths of light, such\n#> as blue and violet, are scattered more than the longer wavelengths, like red\n#> and orange. This is because the smaller gas molecules are more effective at\n#> scattering the shorter wavelengths.\n#> 4. **Blue light reaches our eyes**: As a result of this scattering process, the\n#> blue light is distributed throughout the atmosphere and reaches our eyes from\n#> all directions. This is why the sky appears blue to us.\n#> \n#> Some additional factors can affect the color of the sky:\n#> \n#> * **Time of day**: During sunrise and sunset, the sun's rays have to travel\n#> through more of the Earth's atmosphere, which scatters the shorter wavelengths\n#> even more. This is why the sky often appears redder during these times.\n#> * **Atmospheric conditions**: Dust, pollution, and water vapor in the air can\n#> also affect the color of the sky by scattering or absorbing light.\n#> * **Altitude and location**: The color of the sky can vary depending on your\n#> altitude and location. For example, at higher elevations or near large bodies\n#> of water, the sky may appear more blue due to the reduced amount of atmospheric\n#> gases.\n#> \n#> In summary, the sky appears blue because of the scattering of sunlight by tiny\n#> gas molecules in the atmosphere, which favors shorter wavelengths like blue\n#> light.\n```\n\n## Configuration\n\nYou can configure the server address, the system prompt and the model\nused for a query or chat. If not configured otherwise, `rollama` assumes\nyou are using the default port (11434) of a local instance\n(“localhost”). Let’s make this explicit by setting the option:\n\n``` r\noptions(rollama_server = \"http://localhost:11434\")\n```\n\nYou can change how a model answers by setting a configuration or system\nmessage in plain English (or another language supported by the model):\n\n``` r\noptions(rollama_config = \"You make answers understandable to a 5 year old\")\nquery(\"why is the sky blue?\")\n#> \n#> ── Answer from llama3.1 ────────────────────────────────────────────────────────\n#> So, you know how sometimes we see really bright things like blueberries or blue\n#> crayons? Well, the sky looks kind of like that too!\n#> \n#> The reason the sky is blue is because of something called sunlight. When\n#> sunlight comes from the sun, it goes all around the world and hits our eyes.\n#> \n#> But here's the cool thing about sunlight: it has lots of different colors in\n#> it, like a big ol' rainbow! And guess what? Blue is one of those colors!\n#> \n#> So, when sunlight hits the tiny particles in the air (like really, really small\n#> bits of water or dust), they bounce back up to our eyes. And because blue is\n#> such a strong color in the sunlight, that's the color we see most often.\n#> \n#> That's why the sky looks blue! Isn't that awesome?\n```\n\nBy default, the package uses the “llama3.1 8B” model. Supported models\ncan be found at . To download a specific\nmodel make use of the additional information available in “Tags”\n. Change this via\n`rollama_model`:\n\n``` r\noptions(rollama_model = \"mixtral\")\n# if you don't have the model yet: pull_model(\"mixtral\")\nquery(\"why is the sky blue?\")\n#> \n#> ── Answer from mixtral ─────────────────────────────────────────────────────────\n#> The sky appears blue because of something called \"scattering.\" When the sun's\n#> light reaches our atmosphere, it meets tiny particles and gases. These\n#> particles scatter, or spread out, the sunlight in different directions. Blue\n#> light has a shorter wavelength and gets scattered more easily than other\n#> colors, such as red or yellow, which have longer wavelengths.\n#> \n#> As a result, when we look up at the sky, we see mostly blue light that has been\n#> scattered all around us. This is why the sky usually looks blue during the day!\n```","jobInfo":{"package":"rollama","version":"0.2.0","parsingStatus":"success","parserVersion":2,"parsedAt":"2024-12-06T16:29:48+0000"}}

Description

Usage

Arguments

Value