Skip to content

Commit

Permalink
Adjusted README
Browse files Browse the repository at this point in the history
  • Loading branch information
rmarquis committed Aug 12, 2024
1 parent 5cbf3b7 commit 79065ca
Showing 1 changed file with 4 additions and 51 deletions.
55 changes: 4 additions & 51 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,6 @@
# Create a new service (model from scratch) template
# Planet recognition service (BentoML)

This repository contains the Python + FastAPI template to create a service with
a model built from scratch compatible with the Core engine.
This service provides an example of MLOps tools integration (BentoML) based on the experience presented in the MLOps guide.
_Check the [related documentation](https://docs.swiss-ai-center.ch/reference/services/planet-recognition/) for more information._

Please read the documentation at
<https://docs.swiss-ai-center.ch/how-to-guides/how-to-create-a-new-service> to
understand how to use this template.

## Guidelines

TODO: Add instructions on how to edit this template.

### Publishing and deploying using a CI/CD pipeline

This is the recommended way to publish and deploy your service if you have
access to GitHub Actions or GitLab CI.

TODO

### Publishing and deploying manually

This is the recommended way to publish and deploy your service if you do not
have access to GitHub Actions or GitLab CI or do not want to use these services.

TODO

## Checklist

These checklists allow you to ensure everything is set up correctly.

### Common tasks

- [ ] Rename the project in the [`pyproject.toml`](./pyproject.toml) file
- [x] Add files that must be ignored to the [`.gitignore`](.gitignore) configuration file
- [ ] TODO

### Publishing and deploying using a CI/CD pipeline

> [!NOTE]
> This checklist is specific to the _Publishing and deploying using a CI/CD
> pipeline_ section.
- [x] Add the environment variables
- [ ] TODO

### Publishing and deploying manually

> [!NOTE]
> This checklist is specific to the _Publishing and deploying manually_ section.
- [x] Edit the [`.env`](.env) configuration file
- [ ] TODO
Do note: The model performance is actually not good, as the focus is on the technology stack integration rather than performace.

0 comments on commit 79065ca

Please sign in to comment.