Skip to content

Commit

Permalink
Update default configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
svilupp authored Aug 18, 2024
1 parent 5aaa3e1 commit 0e49097
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ We apply a Retrieval Augment Generation (RAG) pattern, ie,

This ensures that the answers are not only based on general AI knowledge but are also specifically tailored to Julia's ecosystem and best practices.

The "knowledge packs" are sourced from documentation sites and then processed with DocsScraper.jl.
The "knowledge packs" are sourced from documentation sites and then processed with [DocsScraper.jl](https://github.com/JuliaGenAI/DocsScraper.jl).

> [!NOTE]
> If you would like to set up an automated process to create a new knowledge pack for some package/organization, let us know!
Expand Down Expand Up @@ -235,6 +235,9 @@ A: Tavily's API is used to search the best matching snippets from the documentat
**Q: Can we use Ollama (locally-hosted) models?**
A: Yes, see the Advanced section in the docs.

**Q: How can I build knowledge packs for my package(s)?**
A: Check out package [DocsScraper.jl](https://github.com/JuliaGenAI/DocsScraper.jl). It's what we use to build the knowledge packs loaded in this package!

## Future Directions

AIHelpMe is continuously evolving. Future updates may include:
Expand Down
3 changes: 1 addition & 2 deletions src/pipeline_defaults.jl
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ function update_pipeline!(
@warn "Invalid configuration for knowledge packs! For `nomic-embed-text`, `embedding_dimension` must be 0. See the available artifacts."
end
if model_embedding == "text-embedding-3-large" &&
(embedding_dimension [1024, 0] || !isnothing(embedding_dimension))
!(embedding_dimension in [1024, 0] || isnothing(embedding_dimension))
@warn "Invalid configuration for knowledge packs! For `text-embedding-3-large`, `embedding_dimension` must be 0 or 1024. See the available artifacts."
end

Expand Down Expand Up @@ -184,7 +184,6 @@ function update_pipeline!(
## Update GLOBAL variables
MODEL_CHAT = model_chat
MODEL_EMBEDDING = model_embedding
@info embedding_dimension
EMBEDDING_DIMENSION = embedding_dimension

## Set the options
Expand Down

2 comments on commit 0e49097

@svilupp
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

Added (thanks to Splendidbug!)

  • New knowledge packs created by Splendidbug using DocsScraper.jl (to be registered soon, created as part of Google Summer of Code).
  • Knowledge packs for JuliaData org (DataFrames.jl), Plots org, and SciML org.
  • Refreshed knowledge packs for Makie org and Tidier org.
  • Golden Q&A sets for new packages to evaluate performance.

Changed

  • Changed default chunk size to 384 based on evaluation results.
  • Increased compatibility for PromptingTools to v0.50, enabling the use of the latest chat models.
  • Changed const-Ref variables to typed globals to prevent issues encountered in PromptingTools.

Removed

  • Legacy pack "juliaextra".

Fixed

  • Issues related to const-Ref variables by switching to typed globals.
  • Fixed :gold pipeline inconsistently updating the embedding dimension

Notes

  • The new knowledge packs are currently available only for the OpenAI Text embedding Large 3 model.
  • Latest chat models can now be used, but embedding models are restricted for prebuilt knowledge packs.

Commits

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/113353

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.3.0 -m "<description of version>" 0e490972ad015241c8647b729b00f2cc58fc8d4a
git push origin v0.3.0

Please sign in to comment.