Skip to content

Commit

Permalink
Add note about deploying with releases to readme (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
stevehodgkiss authored Mar 16, 2024
1 parent e6e63af commit bba3401
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,19 @@ def deps do
end
```

InstructorEx uses [Code.fetch_docs/1](https://hexdocs.pm/elixir/1.16.2/Code.html#fetch_docs/1) to fetch LLM instructions from the Ecto schema specified in `response_model`. If your project is deployed using [releases](https://hexdocs.pm/mix/Mix.Tasks.Release.html), add the following configuration to mix.exs to prevent docs from being stripped from the release:

```elixir
def project do
# ...
releases: [
myapp: [
strip_beams: [keep: ["Docs"]]
]
]
end
```

## TODO

- [ ] llamacpp adapter broken, needs to support openai input/output API
Expand Down

0 comments on commit bba3401

Please sign in to comment.