Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
edgardmarx authored Apr 22, 2024
1 parent aea6bcd commit 6542143
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ Once Artifactory has started, navigate to the default URL ```http://localhost:80

#### install

coming soon
```
pip install imr
```

#### setup

Expand All @@ -52,15 +54,15 @@ coming soon

#### push

To publish model in a local repository execute the command ```imr local push DIRECTORY PACKAGE -v VERSION``` given the arguments:
To publish the model in a local repository, execute the command ```imr local push DIRECTORY PACKAGE -v VERSION``` given the arguments:
- ```DIRECTORY``` of the model
- ```PACKAGE``` used to identify the model i.e ```org.company.department.project.function.mymodel```
- ```PACKAGE``` used to identify the model, i.e ```org.company.department.project.function.mymodel```
- ```VERSION``` optionally (default latest)
```
imr local push DIRECTORY org.company.department.project.function.mymodel -v v0.0.1
```

To publish model in a remotly repository execute the command ```imr remote push -h REPO -u USER -p PASSWORD DIRECTORY PACKAGE -v VERSION```:
To publish the model in a remotely repository, execute the command ```imr remote push -h REPO -u USER -p PASSWORD DIRECTORY PACKAGE -v VERSION```:
- ```REPO``` repository url i.e. ```http://localhost:8081```
- ```DIRECTORY``` of the model
- ```PACKAGE``` used to identify the model i.e ```org.company.department.project.function.mymodel```
Expand All @@ -72,14 +74,14 @@ imr remote push -h http://localhost:8081 -u user -p password DIRECTORY org.compa

#### path

To publish model in a local repository execute the command ```imr local path PACKAGE -v VERSION``` given the arguments:
- ```PACKAGE``` used to identify the model i.e ```org.company.department.project.function.mymodel```
To publish the model in a local repository, execute the command ```imr local path PACKAGE -v VERSION``` given the arguments:
- ```PACKAGE``` used to identify the model, i.e ```org.company.department.project.function.mymodel```
- ```VERSION``` optionally (default latest)
```
imr local path org.company.department.project.function.mymodel -v v0.0.1
```

To publish model in a remotly repository execute the command ```imr remote path -h REPO -u USER -p PASSWORD PACKAGE -v VERSION```:
To publish the model in a remotely repository execute the command ```imr remote path -h REPO -u USER -p PASSWORD PACKAGE -v VERSION```:
- ```REPO``` repository url i.e. ```http://localhost:8081```
- ```PACKAGE``` used to identify the model i.e ```org.company.department.project.function.mymodel```
- ```VERSION``` optionally (default latest)
Expand All @@ -90,14 +92,14 @@ imr remote path -h http://localhost:8081 -u user -p password org.company.departm

#### remove

To publish model in a local repository execute the command ```imr local rm PACKAGE -v VERSION``` given the arguments:
To publish the model in a local repository, execute the command ```imr local rm PACKAGE -v VERSION``` given the arguments:
- ```PACKAGE``` used to identify the model i.e ```org.company.department.project.function.mymodel```
- ```VERSION``` optionally (default latest)
```
imr local rm org.company.department.project.function.mymodel -v v0.0.1
```

To publish model in a remotly repository execute the command ```imr remote push -h REPO -u USER -p PASSWORD DIRECTORY PACKAGE -v VERSION```:
To publish the model in a remotely repository execute the command ```imr remote push -h REPO -u USER -p PASSWORD DIRECTORY PACKAGE -v VERSION```:
- ```REPO``` repository url i.e. ```http://localhost:8081```
- ```PACKAGE``` used to identify the model i.e ```org.company.department.project.function.mymodel```
- ```VERSION``` optionally (default latest)
Expand Down Expand Up @@ -125,7 +127,7 @@ host=http://localhost:8081
Now, you can execute your client using the config name i.e ```remote```:

```
imr myremoterepo -c remote list
imr remote -c myremoterepo list
```

## Development
Expand Down

0 comments on commit 6542143

Please sign in to comment.