Skip to content

Commit 188d8af

Browse files
author
Emil Gelfort
authored
Merge pull request #4 from SquareFactory/docs_link_fix
Docs link fix
2 parents fab931e + a118a85 commit 188d8af

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
![Isquare deploy logo](docs/imgs/deploy_logo.png)
22
# Isquare client for Python
33

4-
This repository contains the official python client for [ISquare](isquare.ai) deploy. It is available under the form of python classes which are ready to use in your code, as well as a command-line-interface. We currently support inference with image, text & json files, as well as any numpy array or python dictionnary or string, both for input and output.
4+
This repository contains the official python client for [ISquare](http://isquare.ai) deploy. It is available under the form of python classes which are ready to use in your code, as well as a command-line-interface. We currently support inference with image, text & json files, as well as any numpy array or python dictionnary or string, both for input and output.
55

6-
The complete documentation for ISquare can be found [here](docs.isquare.ai).
6+
The complete documentation for ISquare can be found [here](http://docs.isquare.ai).
77

88
## Installation
99

@@ -25,7 +25,7 @@ Docker >= 19.03.13
2525
_Note_: If you only need the client for inference, this is not required.
2626

2727
## Usage
28-
The client can be used to verify your model build (e.g. checking if they will properly run on [ISquare](isquare.ai)) and to perform inference calls to your deployed models. To use this client for inference, you need to have a model up and running on [ISquare](isquare.ai).
28+
The client can be used to verify your model build (e.g. checking if they will properly run on [ISquare](http://isquare.ai)) and to perform inference calls to your deployed models. To use this client for inference, you need to have a model up and running on [ISquare](http://isquare.ai).
2929

3030
Commands and their usage are described [here](docs/commands.md).
3131

@@ -36,12 +36,12 @@ End-to-end guidelines on the code adaptation required to deploy a model on isqua
3636
### Command line interface
3737

3838
#### Test if your model repository is Isquare-compatible
39-
To verify if your code will run smoothly on [ISquare](isquare.ai), you can perform a local build & unit test. This will build a container image with all your specific dependencies and perform an inference test. We've included an example of a simple computer vision model which returns the mirrored image it is given, and it can be tested by running:
39+
To verify if your code will run smoothly on [ISquare](http://isquare.ai), you can perform a local build & unit test. This will build a container image with all your specific dependencies and perform an inference test. We've included an example of a simple computer vision model which returns the mirrored image it is given, and it can be tested by running:
4040

4141
```bash
4242
i2py build examples/tasks/mirror.py
4343
```
44-
When you deploy a model with [ISquare](isquare.ai), you will be provided a url for the model, and requested to create access keys. Using a valid url & access keys (the one displayed are an example), you can perform an inference with an Image model (e.g. the Mirror) and a `.png` image by running:
44+
When you deploy a model with [ISquare](http://isquare.ai), you will be provided a url for the model, and requested to create access keys. Using a valid url & access keys (the one displayed are an example), you can perform an inference with an Image model (e.g. the Mirror) and a `.png` image by running:
4545

4646

4747
```bash

docs/isquare_tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ We strongly recommend that you implement batched inference for your model, since
121121
And that's all you need to get going from the code point of view. Let's proceed, setup our environment and deploy our model!
122122

123123
### Step 1.2: Set up your environment
124-
Most deep learning models are not coded from scratch and depend on external libraries (e.g. python, tensorflow). With isquare.ai, all requirements are handled by a Dockerfile, which is basically a set of instructions which sets up an environment. If you’re new to Docker, check the [documentation](https://docs.docker.com/engine/reference/builder/). We need to create a file containing Docker instructions (usually called Dockerfile):
124+
Most deep learning models are not coded from scratch and depend on external libraries (e.g. pytorch, tensorflow). With isquare.ai, all requirements are handled by a Dockerfile, which is basically a set of instructions which sets up an environment. If you’re new to Docker, check the [documentation](https://docs.docker.com/engine/reference/builder/). We need to create a file containing Docker instructions (usually called Dockerfile):
125125
```dockerfile
126126
FROM alpineintuition/archipel-base-cpu:latest
127127

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Examples
2-
This directory shows 3 sample integrations of the [ISquare](isquare.ai) client for image inference, with 3 levels of complexity:
2+
This directory shows 3 sample integrations of the [ISquare](http://isquare.ai) client for image inference, with 3 levels of complexity:
33
- How to perform inference with an image
44
- How to perform inference with a video
55
- How to stream a camera to your model

0 commit comments

Comments
 (0)