yujunjun/unstructured
1
0
Fork 0
mirror of https://github.com/Unstructured-IO/unstructured.git synced 2025-11-04 12:03:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update readme with notes about pulling and running the public Docker image. (#381)

Browse Source
This commit is contained in:
ryannikolaidis 2023-03-20 11:41:44 -07:00 committed by GitHub
parent fbc7a69a53
commit d5a0fce6a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -83,20 +83,42 @@ print("\n\n".join([str(el) for el in elements]))
## :dizzy: Instructions for using the docker image
The following instructions are intended to help you get up and running using docker to interact with `unstructured`.
The following instructions are intended to help you get up and running using Docker to interact with `unstructured`.
See [here](https://docs.docker.com/get-docker/) if you don't already have docker installed on your machine.
NOTE: the image is only supported for x86_64 hardware and known to have issues on Apple silicon.
We build Docker images for all pushes to `main`. We tag each image with the corresponding short commit hash (e.g. `fbc7a69`) and the application version (e.g. `0.5.5-dev1`). We also tag the most recent image with `latest`. To leverage this, `docker pull` from our image repository.
```bash
docker pull quay.io/unstructured-io/unstructured:latest
```
Once pulled, you can create a container from this image and shell to it.
```bash
# create the container
docker run --platform linux/amd64 -d -t --name unstructured quay.io/unstructured-io/unstructured:latest
# this will drop you into a bash shell where the Docker image is running
docker exec -it unstructured bash
```
You can also build your own Docker image.
If you only plan on parsing one type of data you can speed up building the image by commenting out some
of the packages/requirements necessary for other data types. See Dockerfile to know which lines are necessary
for your use case.
See [here](https://docs.docker.com/get-docker/) if you don't already have docker installed on your machine.
```bash
make docker-build
# this will drop you into a bash shell where the docker image is running
# this will drop you into a bash shell where the Docker image is running
make docker-start-bash
```
Once in the running container, you can try things out directly in Python interpreter's interactive mode.
```bash
# this will drop you into a python console so you can run the below partition functions
python3