Skip to content

Conversation

@pweglik
Copy link
Contributor

@pweglik pweglik commented May 20, 2025

Description

Fixes in generate, error handling and docs

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update (improves or adds clarity to existing documentation)

Tested on

  • iOS
  • Android

Related issues

#305

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly
  • My changes generate no new warnings

@pweglik pweglik requested review from chmjkb and jakmro May 21, 2025 09:14
Comment on lines 63 to 66
**`modelSource`** - `ResourceSource` that specifies the location of the model binary. For more information, take a look at [loading models](../fundamentals/loading-models.md) section.

**`tokenizerSource`** - URL to the JSON file which contains the tokenizer.
**`tokenizerSource`** - `ResourceSource` pointing to the JSON file which contains the tokenizer.

**`tokenizerConfigSource`** - URL to the JSON file which contains the tokenizer config.
**`tokenizerConfigSource`** - `ResourceSource` pointing to the JSON file which contains the tokenizer config.
Copy link
Contributor

@chmjkb chmjkb May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this solves the problem @jakmro mentioned, maybe we should direct here to loading models. In fact we should rename loading models to loading resources, perhaps?

Copy link
Contributor Author

@pweglik pweglik May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ResourceSource that specifies the location of the model binary. For more information, take a look at loading models section.

I direct readers to the details pages here. I think it is enough

}

type ResourceSource = string | number;
type ResourceSource = string | number | object;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this an object btw?

Copy link
Contributor Author

@pweglik pweglik May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is object when we use require to load the resource. It's like that all over the code, somebody simply forgot to change it here

pweglik and others added 4 commits May 21, 2025 15:34
This PR aims to organize our sidebar in docs by introducing a separation
for hooks and TypeScript API. The order of specific subpages will be now
configured by editing `sidebars.js`, instead of the default Docusarus
way. This PR also changes some styling to make the indentations look
prettier.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Documentation update (improves or adds clarity to existing
documentation)

- [ ] iOS
- [ ] Android

<!-- Provide step-by-step instructions on how to test your changes.
Include setup details if necessary. -->

<!-- Add screenshots here, if applicable -->

<!-- Link related issues here using #issue-number -->

- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have updated the documentation accordingly
- [ ] My changes generate no new warnings

<!-- Include any additional information, assumptions, or context that
reviewers might need to understand this PR. -->

---------

Co-authored-by: Mateusz Kopciński <mateusz.kopcinski@swmansnion.com>
@pweglik pweglik force-pushed the @pw/fix-llm-after-qa branch from d81f973 to 42b1c96 Compare May 21, 2025 13:35
@pweglik pweglik merged commit 79a314d into v0.4.0-rc1 May 21, 2025
@pweglik pweglik deleted the @pw/fix-llm-after-qa branch May 21, 2025 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants