From 07cba55207597557382b22d8f70a584f6d846ec3 Mon Sep 17 00:00:00 2001 From: Tommy Albing Date: Thu, 10 Nov 2022 15:50:38 +0100 Subject: [PATCH] Add license and readme. Change-Id: I7197a99f2aa911008bb61a4227a1cd5c820b3de1 --- LICENSE.md | 36 ++++++++++++++++++++++++++++++++++++ README.md | 13 +++++++++++++ 2 files changed, 49 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..7e03b74 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,36 @@ +The Clear BSD License + +Copyright (c) 2018 - 2022, Acconeer AB +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +* Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS +LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +------------------------------------------------------------------------------- + +Some software in this repository is not written by Acconeer AB and is licensed +under other terms and conditions. See license files in the subdirectories for +the external software components. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e50b06b --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Carpet detection + +This project will guide you through how to get started with carpet detection, using Acconeer's A121 sensor. + +In this repo, you will find +- data: A folder with data, used to train the model. Once you have run through the example with the supplied data, feel free to record you own data. +- model_development.ipynb: A notebook guiding you through the processes of feature extraction, model definition, training and evaluation. +- realtime_deployment.py: A python script executing the classification model in realtime. +- utils.py: A python script containing util functions. + +If you want to learn more about Acconeer's sensors, tools and algorithms, please visit the [Documentation site](https://docs.acconeer.com/en/latest/). + +For information on what hardware to get and how to get started with the sensor, please visit [Acconeer's Innovation Lab](https://www.acconeer.com/innovation_lab/algorithm-for-gesture-control/).