Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
esmarkowski committed Mar 28, 2024
1 parent 1770263 commit 816e571
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion docs/guides/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,41 @@ Stretchy.configure do |config|
# or if using Opensearch
# config.client = Openseaerch::Client.new Rails.application.credentials.opensearch
end
```
```

#### Create a model

```ruby
class Product < StretchyModel
attribute :price, :integer
attribute :upc, :keyword
attribute :color, :keyword
end
```

#### Managing Models, Pipelines and Machine Learning Models

Stretchy has a suite of rake tasks built in to make working with Elasticsearch and OpenSearch easier.

```sh
rake stretchy:index:create # Create indices
rake stretchy:index:delete # Delete indices
rake stretchy:index:status # Check the status of all indexes
rake stretchy:ml:delete # Delete the model ENV['MODEL']
rake stretchy:ml:deploy # Deploy the model ENV['MODEL']
rake stretchy:ml:register # Register the model ENV['MODEL']
rake stretchy:ml:status # Check the status of all pipelines
rake stretchy:ml:undeploy # Undeploy the model ENV['MODEL']
rake stretchy:pipeline:create # Create pipeline
rake stretchy:pipeline:delete # Delete pipeline
rake stretchy:pipeline:status # Check the status of all pipelines
rake stretchy:status # Check the status of all indexes, pipelines and ml models
rake stretchy:status:all # Check the status of all indexes
rake stretchy:up # Create all indexes, pipelines and deploy all models
rake stretchy:down # Delete all indexes, pipelines and undeploy all models
```


![rake](../media/stretchy_up.mov)

Run `rake:stretchy:up` to create all Machine Learning models, Pipelines and Indices.
Binary file added docs/media/stretchy_down.mov
Binary file not shown.
Binary file added docs/media/stretchy_up.mov
Binary file not shown.

0 comments on commit 816e571

Please sign in to comment.