/llmsherpa

Client for the nlm-ingestor project

Primary LanguageRubyMIT LicenseMIT

Llmsherpa

This gem implements a Ruby version of the https://github.com/nlmatics/llmsherpa Python package, with the goal of making it easy to parse and ingest documents.

You will need to run an instance of https://github.com/nlmatics/nlm-ingestor. The recommended way is using Docker:

docker pull ghcr.io/nlmatics/nlm-ingestor:latest
docker run -p 5010:5001 ghcr.io/nlmatics/nlm-ingestor:latest

Many thanks to the NLMatics team for their awesome work.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add llmsherpa

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install llmsherpa

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/lpradovera/llmsherpa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Llmsherpa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.