Daptics API Index

This is the index page for documentation about the daptics API and about the daptics API Python client. The daptics API exposes all the functionality of the Daptics web interface, allowing you to incorporate daptics' machine learning algorithms to optimize the design of complex experiments.

You can read more about the daptics system in our overview white paper. Other information is also available at that website.

The currently released version of this page is hosted on GitHub Pages at https://ProtoLife.github.io/daptics-api

Daptics API Resources

The daptics-api GitHub repository contains the following public resources in the python_client folder for you to download, examine and use:

  1. The daptics_client.py Python API client module exposes the DapticsClient class, that allows you to create or connect to a session, set up your experimental space, generate optimized experiments, and obtain analytics results.

  2. There are six interactive Jupyter notebooks in .ipynb files that provide how-tos on installation, explanations of the terminology used by daptics, and tutorials that explore design of experiments solutions using the Python API client module.

Documentation

Visit the Python API Client link for descriptions of the classes and methods exposed by the daptics_client Python module.

Visit the Daptics GraphQL API link for descriptions of all the objects available in the low-level GraphQL API.

Setup and Installation

To use the daptics API, you must first sign up by clicking on the Get Started For Free button on the daptics home page at https://daptics.ai

Please contact support@daptics.ai if you need assistance setting up a daptics account.

Visit the Jupyter Notebooks link for instructions on how you can set up a local Jupyter Notebook server if you do not have access to a server that can open .ipynb files.

Daptics API Version 0.9.3
Copyright (c) 2020 Daptics Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), the rights to use, copy, modify, merge, publish, and/or distribute, copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

You do not have the right to sub-license or sell copies of the Software.

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.