Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
## Contribution Guidelines

Thank you for considering contributing to the project!
Thank you for considering contributing to this project!
Contributions are always welcome and appreciated.

### How to Contribute

Please check the [issue tracker](https://github.com/habedi/template-go-project/issues) to see if there is an issue you
Please check the [issue tracker](https://github.com/CogitatorTech/infera/issues) to see if there is an issue you
would like to work on or if it has already been resolved.

#### Reporting Bugs

1. Open an issue on the [issue tracker](https://github.com/habedi/template-go-project/issues).
1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/infera/issues).
2. Include information such as steps to reproduce, expected/actual behavior, and relevant logs or screenshots.

#### Suggesting Features

1. Open an issue on the [issue tracker](https://github.com/habedi/template-go-project/issues).
1. Open an issue on the [issue tracker](https://github.com/CogitatorTech/infera/issues).
2. Provide details about the feature, its purpose, and potential implementation ideas.

### Submitting Pull Requests
Expand All @@ -31,15 +31,15 @@ would like to work on or if it has already been resolved.

#### Code Style

- Use the `make format` command to format the code.
- Use the `make rust-format` command to format the code.

#### Running Tests

- Use the `make test` command to run the tests.
- Use the `make rust-test` and `make test` commands to run the tests.

#### Running Linters

- Use the `make lint` command to run the linters.
- Use the `make rust-lint` command to run the linters.

#### See Available Commands

Expand Down
26 changes: 19 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,26 +73,38 @@ make release
3. Run the following SQL commands in the shell to try Infera out:

```sql
-- 1. Load the extension (optional when building from source)
load 'build/release/extension/infera/infera.duckdb_extension'
load infera;
-- Normally, we need to load the extension first,
-- but the `duckdb` binary that we built in the previous step
-- already has Infera statically linked to it.
-- So, we don't need to load the extension explicitly.

-- 2. Load a simple linear model from a remote URL
-- 1. Load a simple linear model from a remote URL
select infera_load_model('linear_model',
'https://github.com/CogitatorTech/infera/raw/refs/heads/main/test/models/linear.onnx');

-- 3. Run a prediction using a very simple linear model
-- 2. Run a prediction using a very simple linear model
-- Model: y = 2*x1 - 1*x2 + 0.5*x3 + 0.25
select infera_predict('linear_model', 1.0, 2.0, 3.0);
-- Expected output: 1.75

-- 4. Unload the model when we're done with it
-- 3. Unload the model when we're done with it
select infera_unload_model('linear_model');

-- 5. Check the Infera version
-- 4. Check the Infera version
select infera_get_version();
````

> [!NOTE]
> After building from source, the Infera binary will be `build/release/extension/infera/infera.duckdb_extension`.
> You can load it using the `load 'build/release/extension/infera/infera.duckdb_extension';` in DuckDB shell.
> Note that the extension binary will only work with the DuckDB version that it was built against.
> At the moment, Infera is not available as
> a [DuckDB community extension](https://duckdb.org/community_extensions/list_of_extensions).
> Nevertheless, you can still use Infera by building it from source yourself, or downloading pre-built binaries from
> the [releases page](https://github.com/CogitatorTech/infera/releases) for your platform.
> Please check the [this page](https://duckdb.org/docs/stable/extensions/installing_extensions.html) for more details on
> how to use extensions in DuckDB.

---

### Documentation
Expand Down