Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix document and added png images #456

Merged
merged 2 commits into from
Jun 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added assets/docs/insert_flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/docs/search_flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added design/vald_architecture_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 1 addition & 23 deletions docs/contributing/coding-style.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,10 @@
# Go Style Guide in Vald

## Table of Contents

- [Introduction](#introduction)
- [Code Formatting and Naming Convension](#code-formatting-and-naming-convension)
- [Project Layout](#project-layout)
- [Packages](#packages)
- [Interfaces](#interfaces)
- [Structs](#structs)
- [Struct initialization](#struct-initialization)
- [Variables and Constant](#variables-and-constant)
- [Methods](#methods)
- [Getter and Setter](#getter-and-setter)
- [Error handling](#error-handling)
- [Logging](#logging)
- [Program comments](#program-comments)
- [Documentation](#documentation)
- [Internal packages](#internal-packages)
- [Dependency management and Build](#dependency-management-and-build)
- [Test](#test)
- [Table-Driven-Test](#table-driven-test)
- [The steps to create a Table-Driven-Test](#the-steps-to-create-a-table-driven-test)

## Introduction

This guideline includes the coding style for all Vald contributors and reviewers. Everyone should follow this guideline to keep the style consistent so everyone can understand and contribute to Vald easier once they learn this guideline. You should have the basic knowledge of how to write Go before contributing to Vald. If you found any bug please create [a GitHub issue](https://github.com/vdaas/vald/issues/new?assignees=&labels=type%2Fbug%2C+priority%2Fmedium%2C+team%2Fcore&template=bug_report.md&title=) and we will work on it.

Please also read the [Contribution guideline](../../CONTRIBUTING.md) before you start contributing to Vald.
Please also read the [Contribution guideline](../contributing/contributing-guide.md) before you start contributing to Vald.

## Code Formatting and Naming Convension

Expand Down
1 change: 1 addition & 0 deletions docs/contributing/contributing-guide.md
25 changes: 8 additions & 17 deletions docs/overview/about-vald.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,7 @@

This document gives an overview of what is Vald and what you can do with Vald.

## Table of Contents <!-- omit in toc -->

- [What is Vald?](#what-is-vald)
- [What Vald can do?](#what-vald-can-do)
- [Use cases](#use-cases)
- [Why Vald?](#why-vald)
- [How does Vald work?](#how-does-vald-work)
- [Try Vald](#try-vald)

### What is Vald?
## What is Vald?

<!-- copied from README.md-->
Vald is a highly scalable distributed fast approximate nearest neighbor dense vector search engine.
Expand All @@ -24,7 +15,7 @@ Vald has automatic vector indexing and index backup, and horizontal scaling whic

Vald is easy to use, feature-rich and highly customizable as you needed.

#### What Vald can do?
### What Vald can do?

<!-- copied from README.md-->
- Asynchronous Auto Indexing
Expand Down Expand Up @@ -60,15 +51,15 @@ Vald is easy to use, feature-rich and highly customizable as you needed.
- gRPC APIs can be triggered by any programming languages which support gRPC.
- REST API is also supported.

#### Use cases
### Use cases

Vald supports similarity searching.

- Related image search
- Speech recognition
- Everything you can vectorize :)

### Why Vald?
## Why Vald?

Vald is based on Kubernetes and Cloud-Native architecture, which means Vald is highly scalable.
You can easily scale Vald by changing Vald's configuration.
Expand All @@ -78,13 +69,13 @@ Vald uses the fastest ANN Algorithm [NGT](https://github.com/yahoojapan/NGT) to
Also, Vald supports auto-healing, to reduce running and maintenance costs. Vald implements the backup mechanism to support disaster recovery.
Whenever one of the Vald Agent instances is down, the new Vald Agent instance will be created automatically and the data will be recovered automatically.

### How does Vald work?
## How does Vald work?

Vald implements its custom resource and custom controller to integrate with Kubernetes.
You can take all the benefits from Kubernetes.

Please refer to the [architecture overview](./architecture.md) for more details about the architecture and how each component in Vald works together.
Please refer to the [architecture overview](../overview/architecture.md) for more details about the architecture and how each component in Vald works together.

### Try Vald
## Try Vald

Please refer to [Get Started](../get-started/get-started.md) to try Vald :)
Please refer to [Get Started](../tutorial/get-started.md) to try Vald :)
13 changes: 3 additions & 10 deletions docs/overview/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,6 @@

This document describes the high-level architecture design of Vald and explains each component in Vald.

## Table of Contents <!-- omit in toc -->

- [Overview](#overview)
- [Data Flow](#data-flow)
- [Insert](#insert)
- [Search](#search)

## Overview

Vald uses a cloud-native architecture focusing on [Kubernetes](https://kubernetes.io/).
Expand All @@ -17,7 +10,7 @@ Before reading this document, you need to have some understanding of the basic i

The below image is Vald's architecture.

<img src="../../design/Vald Future Architecture Overview.svg" />
<img src="../../design/vald_architecture_overview.png" />

We will explain this image in the following section.

Expand All @@ -28,7 +21,7 @@ This is the most important part for the users to understand Vald.

### Insert

<img src="../../assets/docs/insert_flow.svg" />
<img src="../../assets/docs/insert_flow.png" />

When the user inserts data into Vald:

Expand All @@ -53,7 +46,7 @@ When the user inserts data into Vald:

### Search

<img src="../../assets/docs/search_flow.svg" />
<img src="../../assets/docs/search_flow.png" />

When the user searches a vector from Vald:

Expand Down
9 changes: 0 additions & 9 deletions docs/tutorial/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@ Vald is designed and implemented based on Cloud-Native architecture.
This article will show you how to deploy and run the Vald components on your kubernetes cluster.
Fashion-mnist is used as an example of a dataset.

- [Get Started](#get-started)
- [Requirements](#requirements)
- [Deploy and Run Vald on kubernetes](#deploy-and-run-vald-on-kubernetes)
- [Deploy](#deploy)
- [Run using example code](#run-using-example-code)
- [Deploy and Run standalone Vald Agent on kubernetes](#deploy-and-run-standalone-vald-agent-on-kubernetes)
- [Deploy](#deploy-1)
- [Run using example code](#run-using-example-code-1)

## Requirements

- kubernetes: v1.17 ~
Expand Down
10 changes: 5 additions & 5 deletions docs/user-guides/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You can specify image version by set `image.tag` field in each component (`[comp
```yaml
defaults:
image:
tag: v0.0.33
tag: master
```

or you can use the older image only for agent,
Expand Down Expand Up @@ -405,13 +405,13 @@ For further details, there are references of Helm values in GitHub Vald reposito
- [README of Vald-Helm-Operator Chart][vald-helm-operator-chart]


[vald-helm-chart]: https://github.com/vdaas/vald/tree/v0.0.33/charts/vald
[vald-helm-operator-chart]: https://github.com/vdaas/vald/tree/v0.0.33/charts/vald-helm-operator
[vald-helm-chart]: https://github.com/vdaas/vald/tree/master/charts/vald
[vald-helm-operator-chart]: https://github.com/vdaas/vald/tree/master/charts/vald-helm-operator

[vald-operation-guide]: ./operations.md

[vald-apis-docs]: https://github.com/vdaas/vald/tree/v0.0.33/apis/docs
[vald-swagger-specs]: https://github.com/vdaas/vald/tree/v0.0.33/apis/swagger
[vald-apis-docs]: https://github.com/vdaas/vald/tree/master/apis/docs
[vald-swagger-specs]: https://github.com/vdaas/vald/tree/master/apis/swagger
[google-pprof]: https://github.com/google/pprof
[prometheus-io]: https://prometheus.io/
[kubernetes-liveness-readiness]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
Expand Down