You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1.[**Download the latest version**](https://www.codeproject.com/ai/sense/latest.aspx), install, and launch the shortcut to the server's dashboard on your desktop.
34
-
2. On the dashboard, at the bottom, is a link to the demo playground. Open that and play!
36
+
2. On the dashboard, top and centre, is a link to the senseAI Explorer. Open that and play!
35
37
36
38
### 2: Running and debugging the code
37
39
@@ -92,7 +94,10 @@ CodeProject SenseAI can currently
92
94
- Detect faces in images
93
95
- Detect the type of scene represented in an image
94
96
- Recognise faces that have been registered with the service
97
+
- Remove a background from an image
98
+
- Blur a background from an image
95
99
- Pull out the most important sentences in text to generate a text summary
100
+
- Prove sentiment analysis on text
96
101
97
102
We will be constantly expanding the feature list.
98
103
@@ -103,183 +108,16 @@ We will be constantly expanding the feature list.
103
108
3.**To focus on core use-cases**. We're deliberately not a solution for everyone. Instead we're a solution for common day-to-day needs. We will be adding dozens of modules and scores of AI capabilities to our system, but our goal is always clarity and simplicity over a 100% solution.
104
109
4.**To tap the expertise of the Developer Community**. We're not experts but we know a developer or two out there who are. The true power of CodeProject SenseAI comes from the contributions and improvements from our AI community.
105
110
106
-
## How to download and install CodeProject.SenseAI
107
111
108
112
#### Supported Development Environments
109
113
110
114
This current release works in Visual Studio 2019+ on Windows 10+, and Visual Studio Code on Windows 10+. Ubuntu and macOS (both Intel and Apple Silicon). The current release focuses solely on CPU support, but future releases will include GPU support.
111
115
112
-
### Installing CodeProject.SenseAI
113
-
114
-
#### Windows
115
-
116
-
To **install CodeProject.SenseAI** as a standalone service ready for integration with applications such as HomeAssist or BlueIris, download the [latest installation package](https://www.codeproject.com/ai/sense/latest.aspx).
117
-
118
-
Double click the installer. This will install the server as a Windows Service. SenseAI Server and the backend analysis services will now be running, and will automatically restart each time your machine is restarted.
119
-
120
-
To **explore CodeProject.SenseAI** Click on the SensaAI playground link on the server dashboard. The server will, of course, need to be running for this test application to function. Sample images can be found in the <code>TestData</code> folder under the <code>C:\Program Files\CodeProject\SenseAI</code> folder
121
-
122
-
#### Docker
123
-
124
-
##### For Windows
125
-
126
-
```
127
-
docker run -p 5000:5000 --name SenseAI-Server -d -v c:\ProgramData\CodeProject\SenseAI:/usr/share/CodeProject/SenseAI codeproject/senseai-server
128
-
```
129
-
130
-
##### For Linux
131
-
132
-
```
133
-
docker run -p 5000:5000 --name SenseAI-Server -d -v /usr/share/CodeProject/SenseAI:/usr/share/CodeProject/SenseAI codeproject/senseai-server
134
-
```
135
-
136
-
##### For macOS, choose a port other than 5000 such as 5500:
137
-
138
-
```
139
-
docker run -p 5500:5000 --name SenseAI-Server -d -v /usr/share/CodeProject/SenseAI:/usr/share/CodeProject/SenseAI codeproject/senseai-server
140
-
```
141
-
142
-
For Docker, please visit http://localhost:5000/testdata.zip (after launching SenseAI server) to download some test images for use with the SenseAI playground
143
-
144
-
### Setting up the development environment
145
-
146
-
If you wish to debug or make enhancements to the code then you should install:
147
-
148
-
1.**Visual Studio Code** or **Visual Studio 2019+**. [VS Code](https://code.visualstudio.com/download) is available on Windows, macOS and Linux. Visual Studio is available on Windows and macOS. We've tested against both, but not against other IDEs at this point
149
-
150
-
2.**Python**. You may add Python support either via the Visual Studio Installer, through Visual Code Extensions, or by [downloading python directly](https://www.python.org/downloads/). However, this is not needed since Python will be installed automatically as part of the development environment setup script.
151
-
152
-
3.**.NET 6 SDK** Download the [.NET SDK 6 here](https://dotnet.microsoft.com/download/dotnet/6.0).
153
-
154
-
4. For the **(Optional) WIX installers** we do all our work within Visual Studio. For this you will need to
155
-
a. Extensions -> Manage Extensions, search for Wix and install Wix toolset Visual Studio 2019 Extension
156
-
b. Download the Wix Toolset Build tools by heading to the [download page](https://wixtoolset.org/releases/), clicking the download link, and then download the .exe installer from the GitHub page you're directed to. The [current version](https://github.com/wixtoolset/wix3/releases/download/wix3112rtm/wix311.exe) is 3.11.
157
-
c. Ensure you have .NET 3.5.1 (that's not a typo) installed. See the **/Installers/Windows/.NET 3.5.1** directory for a link to the installer download.
158
-
159
-
You do not need to install support for creating the installers for general development.
160
-
161
-
#### Platform Specific
162
-
163
-
1. For **Windows** simply ensure the .NET 6 SDK is installed.
164
-
165
-
2. For **Ubuntu** 21.10, 21.04 (inc. LTS), 18.04 (LTS) first install the .NET 6 packages
where <UBUNTU-VERSION-HERE> is the version of Ubuntu (use `lbs_release -d` to find your current version). **Note** that for Ubuntu 21.10 you should use 21.04 due to the 21.10 packages not yet being available.
173
-
174
-
To install the .NET 6 SDK on Ubuntu run
175
-
176
-
```bash
177
-
sudo apt-get update; \
178
-
sudo apt-get install -y apt-transport-https && \
179
-
sudo apt-get update && \
180
-
sudo apt-get install -y dotnet-sdk-6.0
181
-
```
182
-
183
-
See [Install the .NET SDK or the .NET Runtime on Ubuntu](https://docs.microsoft.com/en-us/dotnet/core/install/linux-ubuntu) for more information.
184
-
185
-
3. For **macOS** just use the [standalone .NET SDK installers](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
186
-
187
-
#### If you are using VS Code
188
-
189
-
You'll need the following extensions
190
-
191
-
1. [Python extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
192
-
193
-
2. [C# extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp).
194
-
195
-
196
-
##### If you are using VS Code on WSL (Windows Subsystem for Linux)
197
-
198
-
1. You will need to install the [C# Extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) for WSL, even if you've already installed it for Windows.
199
-
200
-
Load up the SenseAI project in VS Code within Ubuntu by navigating to the SenseAI root folder in a Ubuntu window and typing "`code .`". Then head to the [C# Extension page](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp), choose install, and the extension should be installed. If you get a warning that there is an instance of VS Code already running, close VS code and hit the install button again.
201
-
202
-
2. Also install the [Remote WSL Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl) for Visual Studio Code.
203
-
204
-
### To build and run:
205
-
206
-
1. Clone the [CodeProject.SenseAI repository](https://github.com/codeproject/CodeProject.SenseAI.git) from GitHub
207
-
208
-
2. run `/installers/Dev/setup_dev_env_win.bat` (for windows) or `sudo bash setup_dev_env_linux.sh` (for Ubuntu or macOS). This will download required assets and setup the Python environment.
209
-
210
-
211
-
#### If you are using VS Code
212
-
213
-
1. Open the main application folder in VS Code
214
-
215
-
2. Click the "Run and Debug" button on the left hand tab bar (the arrow)
216
-
217
-
3. From the dropdown at the top of the window, select**Launch CodeProject.SenseAI**
218
-
219
-
220
-
4. CLick the green arrow next to the dropdown
221
-
222
-
The dashboard webpage should launch after the code has built and the server has started.
223
-
224
-
225
-
#### If you are using Visual Studio
226
-
227
-
1. You may wish to have the Python workflow enabled in Visual Studio. While not critical, it does help with debugging.
228
-
229
-
2. Open the solution in Visual Studio and build the entire solution
230
-
231
-
3. To run the Server and the demo application in DEBUG you can either
232
-
233
-
1. Start both the projects in debug mode by
234
-
1. In Solution Explorer, open demos / .NET and right-click on CodeProject.SenseAI.Playground and choose Debug -> Start new instance.
235
-
2. In Solution Explorer, open src / API / Server and right-click on FrontEnd and choose Debug -> Start new instance.
236
-
237
-
2. Configure Visual Studio to start multiple projects by
238
-
1. In Solution Explorer, right-click on the solution and select**Set Startup Projects...** and configure Multiple startup projects as shown below.
4. In Solution Explorer, open src / AnalysisLayer. Right click on DeepStack and choose <code>Open Folder in File Explorer</code>. Double click on the start.bat script. This script will ensure that the Python virtual environment is enabled and environment variables set.
245
-
246
-
#### It's running!
247
-
248
-
At this point the Playground application should be indicting it has a connection to the API server, and the server should be dispatching requests to the backend Analysis layer.
249
-
250
-
#### Common Errors
251
-
252
-
**YOLO ONNX models not found**
253
-
254
-
When building you see:
255
-
```text
256
-
error MSB3030: Could not copy the file "<path>\CodeProject.SenseAI.AnalysisLayer.Yolo\assets\yolov5m.onnx" because it was not found.
257
-
```
258
-
Ensure you've run the development setup scripts before attempting to build
259
-
260
-
**Server startup failed**
261
-
262
-
```
263
-
System.ComponentModel.Win32Exception (2): The system cannot find the file specified.
264
-
at System.Diagnostics.Process.StartWithCreateProcess(ProcessStartInfo startInfo)
265
-
```
266
-
267
-
Ensure you've run the development setup scripts before attempting to start the server
268
-
269
-
**Port already in use**
270
-
271
-
If you see:
272
-
```
273
-
Unable to start Kestrel.
274
-
System.IO.IOException: Failed to bind to address http://127.0.0.1:5000: address already in use.
275
-
```
276
-
Either you have CodeProject.SenseAI already running, or another application is using port 5000. Either shut down any application using port 5000, or change the port CodeProject.SenseAI uses. You can change the external port that CodeProject.SenseAI uses by editing the <code>appsettings.json</code> file and changing the value of the <code>PORT</code> variable. In the demo app there is a Port setting you will need to edit to match the new port.
277
116
278
-
## Roadmap
117
+
## How to Guides
279
118
280
-
The following features will be added over the coming weeks and months
119
+
-[Installing senseAI on your machine](https://www.codeproject.com/ai/senseai/why/install_on_windows.html). For those who have senseAI integrated with HomeAssist or Blue Iris
120
+
-[Setting up the development environment](https://www.codeproject.com/ai/senseai/devguide/install_dev.html) (spoiler: it's easy!)
121
+
-[Running in Docker](https://www.codeproject.com/ai/senseai/why/running_in_docker.html)
122
+
- Setup or install issues? See [Common Errors](https://www.codeproject.com/ai/senseai/devguide/common_errors.html)
281
123
282
-
1. More modules and a streamlined plugin architecture
0 commit comments