Skip to content

Commit

Permalink
Adds stub README
Browse files Browse the repository at this point in the history
  • Loading branch information
edgararuiz committed Oct 7, 2024
1 parent 87cb1ec commit 16003a9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 4 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# mall

<img src="figures/favicon/apple-touch-icon-180x180.png" style="float:right" />


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/

8 changes: 4 additions & 4 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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://[email protected]/edgararuiz/mall.git@python#subdirectory=python"
pip install "mall @ git+https://[email protected]/edgararuiz/mall.git#subdirectory=python"
```
:::

Expand Down

0 comments on commit 16003a9

Please sign in to comment.