diff options
author | Jon Bratseth <bratseth@gmail.com> | 2021-03-19 11:20:33 +0100 |
---|---|---|
committer | Jon Bratseth <bratseth@gmail.com> | 2021-03-19 11:20:33 +0100 |
commit | f91afc60744084945f6a4e6c79277d61677dc7fb (patch) | |
tree | 9a4291dc5c4c77f1e2a0804cc2a3a51c61953e11 /README.md | |
parent | e477cfaf1cf1860c280fa928509905845078ad2c (diff) |
Minor improvements
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 35 |
1 files changed, 19 insertions, 16 deletions
diff --git a/README.md b/README.md index 6a452c10f77..88da5ec887e 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,15 @@ [![#Vespa](https://vespa.ai/assets/vespa-logo-color.png)](https://vespa.ai) -The big data serving engine - Store, search, rank and organize big data at user serving time. -Vespa is an engine for low-latency computation over large data sets. -It stores and indexes your data and executes distributed queries including evaluation of -machine-learned models over many data points in real time. +The open big data serving engine - Store, search, organize and make machine-learned inferences +over big data at serving time. + +This is the primary repository for Vespa where all development is happening. +New production releases from this repository's master branch are made each weekday from Monday to Thursday. + +Home page: [https://vespa.ai](https://vespa.ai) +Documentation: [https://docs.vespa.ai/](https://docs.vespa.ai/) +Run applications in the cloud for free: [https://cloud.vespa.ai](https://cloud.vespa.ai) Screwdriver build status: [![Build Status](https://cd.screwdriver.cd/pipelines/6386/badge)](https://cd.screwdriver.cd/pipelines/6386) @@ -24,24 +29,21 @@ Use cases such as search, recommendation and personalization need to select a su evaluate machine-learned models over the selected data, organize and aggregate it and return it, typically in less than 100 milliseconds, all while the data corpus is continuously changing. -This is hard to do, especially with large corpuses that needs to be distributed over multiple nodes and evaluated in -parallel. Vespa is a platform which performs these operations for you. It has been in development for many years -and is used on a number of large internet services and apps which serve hundreds of thousands of queries from -Vespa per second. +This is hard to do, especially with large data sets that needs to be distributed over multiple nodes and evaluated in +parallel. Vespa is a platform which performs these operations for you with high availability and performance. +It has been in development for many years and is used on a number of large internet services and apps which serve +hundreds of thousands of queries from Vespa per second. + ## Install -To get started using Vespa pick one of the quick start documents: +Run your own Vespa instance: [https://docs.vespa.ai/en/getting-started.html](https://docs.vespa.ai/en/getting-started.html) +Or deploy your Vespa applications to the cloud service: [https://cloud.vespa.ai](https://cloud.vespa.ai) -- [Run on a Mac or Linux machine using Docker](https://docs.vespa.ai/en/vespa-quick-start.html) -- [Run on a Windows machine using Docker](https://docs.vespa.ai/en/vespa-quick-start-windows.html) -- [Run on a Mac or Linux machine using VirtualBox+Vagrant](https://docs.vespa.ai/en/vespa-quick-start-vagrant.html) -- [Multinode install on AWS EC2](https://docs.vespa.ai/en/vespa-quick-start-multinode-aws.html) -- [Multinode install on AWS ECS](https://docs.vespa.ai/en/vespa-quick-start-multinode-aws-ecs.html) ## Usage -- The application created in the quickstart is fully functional and production ready, but you may want to [add more nodes](https://docs.vespa.ai/en/multinode-systems.html) for redundancy. +- The application created in the getting started guide is fully functional and production ready, but you may want to [add more nodes](https://docs.vespa.ai/en/multinode-systems.html) for redundancy. - Try the [Blog search and recommendation tutorial](https://docs.vespa.ai/en/tutorials/blog-search.html) to learn more about using Vespa - See [developing applications](https://docs.vespa.ai/en/developer-guide.html) on adding your own Java components to your Vespa application. - [Vespa APIs](https://docs.vespa.ai/en/api.html) is useful to understand how to interface with Vespa @@ -49,6 +51,7 @@ To get started using Vespa pick one of the quick start documents: Full documentation is available on [https://docs.vespa.ai](https://docs.vespa.ai). + ## Contribute We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute. @@ -67,7 +70,7 @@ Some suggested improvements with pointers to code are in [TODO.md](TODO.md). C++ and Java building is supported on CentOS 7. The Java source can also be built on any platform having Java 11 and Maven installed. -Use the following guide to setup a complete development environment using Docker +Use the following guide to set up a complete development environment using Docker for building Vespa, running unit tests and running system tests: [Vespa development on CentOS 7](https://github.com/vespa-engine/docker-image-dev#vespa-development-on-centos-7). |