README for example application code

[alexcg1]

Template description

We develop a neural search framework and have a bunch of different examples covering text search, image search, video search, etc.

Note: these are self-contained examples, not just snippets of example code

Each example downloads a dataset and allows a user to index and query it. They are then free to edit the code and use their own dataset to build their own search app.

These serve 2 purposes:

• Template code for users to start their search applications
• Simple explanation of what the code does (what goes in, what comes in, how to run either on bare metal or in Docker)

Benefits

• Reduces friction for users
• Reduces thinking time for the writers
• Provides a simple template for anyone who wants to contribute their own example

Use cases

• Introduce example code
• Explain example code

Additional information

At the moment our examples are a mish-mash of:

• Actual example you can run by cloning the repo and following the example README
• "Tutorial" - in quotes because the code in the repo is actually complete - there is nothing there for the user to do to build the example since it's pre-built

We're still working out how to address the above.

• image search example
• text search example