From 16003a9326fe90f3ad118a87a043837d8136ec43 Mon Sep 17 00:00:00 2001 From: Edgar Ruiz Date: Mon, 7 Oct 2024 15:26:17 -0500 Subject: [PATCH] Adds stub README --- README.md | 13 +++++++++++++ index.qmd | 8 ++++---- 2 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6fd398a --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# mall + + + + +Run multiple LLM predictions against a data frame. The predictions are +processed row-wise over a specified column. It works using a +pre-determined one-shot prompt, along with the current row’s content. +`mall` is now available in both R and Python. + +To find out how to install and use, or just to learn more about it, please +visit the official website: https://edgararuiz.github.io/mall/ + diff --git a/index.qmd b/index.qmd index f8cf4e8..f2d0f9b 100644 --- a/index.qmd +++ b/index.qmd @@ -25,8 +25,8 @@ mall::llm_use("ollama", "llama3.2", seed = 100, .cache = "_readme_cache") Run multiple LLM predictions against a data frame. The predictions are processed row-wise over a specified column. It works using a pre-determined one-shot prompt, -along with the current row's content. The prompt that is use will depend of the -type of analysis needed. +along with the current row's content. `mall` has been implemented for both R +and Python. The prompt that is use will depend of the type of analysis needed. Currently, the included prompts perform the following: @@ -84,12 +84,12 @@ corporate network. ::: {.panel-tabset group="language"} ## R ```r -pak::pak("edgararuiz/mall/r@python") +pak::pak("edgararuiz/mall/r") ``` ## python ```python -pip install "mall @ git+https://git@github.com/edgararuiz/mall.git@python#subdirectory=python" +pip install "mall @ git+https://git@github.com/edgararuiz/mall.git#subdirectory=python" ``` :::