Skip to content

Commit e49d610

Browse files
authored
Improve the getting started section (#5)
1 parent 42590a4 commit e49d610

File tree

2 files changed

+26
-14
lines changed

2 files changed

+26
-14
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
## Contribution Guidelines
22

3-
Thank you for considering contributing to the project!
3+
Thank you for considering contributing to this project!
44
Contributions are always welcome and appreciated.
55

66
### How to Contribute
77

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

1111
#### Reporting Bugs
1212

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

1616
#### Suggesting Features
1717

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

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

3232
#### Code Style
3333

34-
- Use the `make format` command to format the code.
34+
- Use the `make rust-format` command to format the code.
3535

3636
#### Running Tests
3737

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

4040
#### Running Linters
4141

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

4444
#### See Available Commands
4545

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,26 +73,38 @@ make release
7373
3. Run the following SQL commands in the shell to try Infera out:
7474

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

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

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

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

92-
-- 5. Check the Infera version
93+
-- 4. Check the Infera version
9394
select infera_get_version();
9495
````
9596

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

98110
### Documentation

0 commit comments

Comments
 (0)