Migrate to TypeScript - Githubissues

mubaidr commented 4 years ago

We plan to gradually migrate brain.js to TypeScript, code base is pretty large, so we would love your help! 💪

How to contribute?

Convert a file from .js to .ts
Add types, fix all type errors.
Submit a PR! 🎉

Here you can find a guide on how to contribute.

Want to convert something, let us know in the comment and go ahead! 😎

To avoid duplicate work please comment on which part you want to work on (as long as nobody else is working on it) so we can mark it as taken.

Reach out to us! Feel free to reach if you have questions or need help getting started. You can leave comments here or you can tag me in your PR if you need any help or you're not sure about something!

You can also get in touch on our & .

Happy Coding! 🤟

UPDATE:

Wohoooo!!! 🎉

All files inside src directory are migrated to typescript. (Except few ones which are already taken up and being worked on), though we are still looking on improvements to types in these files and removing any types from the source. You are welcome to contribute. 😊

__tests__ directory has still some files left that needs migration to typescript, so feel free to pick em up! 🍭

UPDATE

For anyone looking to contribute, here is the list of files that still needs typescript migration:

https://github.com/BrainJS/brain.js/search?l=javascript&p=1

yashshah1 commented 4 years ago

I'd like to start working on this, I have some experience with Ts, can you tell me which module is up for grabs?

mubaidr commented 4 years ago

@yashshah1 You are welcome to contribute, please pick any module or portion for conversion and mention it here, so I can mark it in-progress (to avoid any duplication effort).

nabeelvalley commented 4 years ago

I'd like to work on this too, any recommendations on where to start?

mubaidr commented 4 years ago

@nabeelvalley here is the short guide, super simple to start. Please pick any module or portion for conversion and mention it here, so I can mark it in-progress (to avoid any duplication effort).

Here you can find a guide on how to contribute.

nabeelvalley commented 4 years ago

@mubaidr I'm working from the utilities up, to avoid having untyped dependencies

The tests seem to be failing when I convert the file to JS because it looks like Jest is running against the TS files instead of the compiled JS - has the TS Compile been configured?

Looks like the tests are also currently failing:

Test Suites: 1 failed, 5 passed, 6 of 64 total
Tests:       9 failed, 114 passed, 123 total
Snapshots:   0 total
Time:        206.723 s

It appears that the soft-max tests are receiving a Float32Array instead of a plain array - should I look where the Float32 is coming from or should I update the unit tests to expect a Floar32Array instead?

The data returned looks exactly the same, it's just that the object types are different so the deep equality is failing:

Example for one of the tests below:

  ● SoftMax › .compare2D › can run on a simple matrix

    assert.deepEqual(received, expected)

    Expected value to deeply equal to:
      [[-0, 2], [3, 4]]
    Received:
      [[-0, 2], [3, 4]]

    Difference:

    - Expected
    + Received

      Array [
    -   Array [
    +   Float32Array [
          -0,
          2,
        ],
    -   Array [
    +   Float32Array [
          3,
          4,
        ],
      ]

mubaidr commented 4 years ago

Yes, you can update test to expect Float32Array.

In the mean-time some tests might still fail, because they have not yet been updated recently. You can can continue working and make sure build process is successful and conversion does not cause increase in no. of failed tests.

harshkhandeparkar commented 4 years ago

Hi! I want to help. If I convert one file, do I need to convert related files too or something? Or just a single file?

mubaidr commented 4 years ago

You don't need to updated all the related files, just go file by file and make sure build is successful.

harshkhandeparkar commented 4 years ago

Utilities is taken, isnt it?

harshkhandeparkar commented 4 years ago

Activation functions seem like a good place to start, may I work on it?

nabeelvalley commented 4 years ago

Utilities is taken, isnt it?

Hi @HarshKhandeparkar, I haven't had a chance to work on this you're welcome to take utilities if you want, just note that needs to be updated above

harshkhandeparkar commented 4 years ago

Np @nabeelvalley. I think I'll work on activation functions :)

harshkhandeparkar commented 4 years ago

@nabeelvalley I think I managed to fix the jest error you were facing in #582. You may copy paste my changes to jest.config.json or wait for the PR to be merged :)

harshkhandeparkar commented 4 years ago

estimator/ has a single file. Looks like a nice :dart:.

harshkhandeparkar commented 4 years ago

I think I'll snipe some of the utilities next, if you don't mind @nabeelvalley.

harshkhandeparkar commented 4 years ago

You would have probably started in alphabetical order(I am assuming), so I am going to start from the bottom.

harshkhandeparkar commented 4 years ago

Going to snipe utilities/values* tonight :)

robertleeplummerjr commented 4 years ago

Huzzah!

mubaidr commented 4 years ago

Build systems seems to be broken, I am looking into this issue. 🧯

harshkhandeparkar commented 4 years ago

Can I continue or should I wait?

mubaidr commented 4 years ago

You should continue your contributions! I will try to fix it asap.

nabeelvalley commented 4 years ago

Hi All, taking a look at doing some of these as well today, starting from the top of utilities seeing as @HarshKhandeparkar has started from the bottom

nabeelvalley commented 4 years ago

Note, I haven't done utilities/array-lookup-table as it looks like it's working with some dynamic types and a few different cases and it's a bit difficult to infer all of these (in my opinion) until recurrent/rnn-time-step is updated. So doing it after that seems to make sense

I'm also not sure what's going on with the builds/tests as I had some issues from when I pulled the code to begin with, and the errors seem to be inconsistent (I assume due to the order in which tests are running etc.)

harshkhandeparkar commented 4 years ago

I am going to stop targeting utilitites for a while now. Apparently some of them refer to layer etc. So I am starting with layer/ today. I am going to drop a nuke on it :grin:

robertleeplummerjr commented 4 years ago

Love it!

harshkhandeparkar commented 4 years ago

I'll actually work on utilities/kernel first because it is referenced in layer/base. I'll do base after that.

harshkhandeparkar commented 4 years ago

NOTE: layer/base is a HOT MESS.

harshkhandeparkar commented 4 years ago

I also wanted to underline that but apparently underline isn't supported on github.

robertleeplummerjr commented 3 years ago

I'm taking over the layer folder from @HarshKhandeparkar (we coordinated already), and will need utilities either done soon, or will need to go ahead and handle:

utilities/kernel.js
utilities/random.js
utilities/randos.js
utilities/randos-2d.js
utilities/randos-3d.js

I'd also eventually like to consolidate these into a single file, but for a later task.

nabeelvalley commented 3 years ago

Going to continue working on utilities as well, will update on here as I go:

utilities/to-array
utilities/max

nabeelvalley commented 3 years ago

__tests__/utilities/mse.js

  test('should return an array if object is passed', () => {
    const collection = {
      name: 'Steve Jobs',
      alive: false,
    };
    const temp = toArray(collection);

    expect(temp.constructor).toBe(Float32Array);
    expect(temp.length).toBe(Object.keys(collection).length);
  });

harshkhandeparkar commented 3 years ago

@robertleeplummerjr I remember doing utilities/kernel.

harshkhandeparkar commented 3 years ago

I can take utilities/random and utilities/random-weight if no one else wants to take it.

harshkhandeparkar commented 3 years ago

@mubaidr The imports are broken and the tests are failing, am I supposed to ignore all of that and force commit?

mubaidr commented 3 years ago

@HarshKhandeparkar I have fixed the issue. You can create pull request now.

harshkhandeparkar commented 3 years ago

I'll convert the randos kernel tomorrow :)

robertleeplummerjr commented 3 years ago

I have randos done already, but if younknocknitnout, it all good.

On Thu, Sep 10, 2020, 12:58 PM Harsh Khandeparkar notifications@github.com wrote:

I'll convert the randos kernel tomorrow :)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/BrainJS/brain.js/issues/551#issuecomment-690507706, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFFZO63XW4THPXV4XGVTNLSFEATPANCNFSM4NDROIUQ .

harshkhandeparkar commented 3 years ago

I have randos done already, but if younknocknitnout, it all good.

Oops, sorry but I opened a PR while you were deep asleep ;)

ofirgeller commented 3 years ago

@mubaidr 1) Which file(s) can I work on? 2) is it expected that the many tests fail at the moment?

I am have lots of free time in the next 1-2 weeks and years of experience working with typescript, so if you give me the "go ahead" I can probably convert the whole thing.

nabeelvalley commented 3 years ago

@ofirgeller

we've been handling them sort of from utilities up, because a lot of files depend on those, just keep us updated on here for whichever file you're doing and that should be fine
i'd noticed some tests are failing at the moment too, think @mubaidr was looking into that

the type checker and linter shouldn't have any issues though - i think there are just two type checker warnings from what i last saw

mubaidr commented 3 years ago

@ofirgeller You can select any files from the the repo, and mention it here so that no effort is duplicated. Yes, we do have some failing tests, and we are working on this issue, but as @nabeelvalley said, you can start from utilities and we do have lint and typescript scripts (npm run lint) to help catch errors during conversion process.

ofirgeller commented 3 years ago

Converted "array-lookup-table.js" (short and sweet), moving on to DataFormatter which will take a bit longer.

mubaidr commented 3 years ago

@ofirgeller I recommend creating a pull request per file (and related changes i.e. imports etc) to make it easier for code review and merge.

ofirgeller commented 3 years ago

@mubaidr If each atomic change is a a separate commit on the same branch, do you still want each commit to be its own PR?

mubaidr commented 3 years ago

No. multiple commits per PR is good.

robertleeplummerjr commented 3 years ago

@mubaidr and @HarshKhandeparkar, layers are here: https://github.com/BrainJS/brain.js/compare/ts-layers

They are not done, but I've laid the foundation for what they'll look like. I just pushed it, and will merge test into it shortly and resolve conflicts. This includes some pretty heavy upgrades from typescript typings from gpu.js.

robertleeplummerjr commented 3 years ago

Tons more layer conversion, including pool.ts and convolution.ts!

robertleeplummerjr commented 3 years ago

All layers have now been converted. Opened PR here: https://github.com/BrainJS/brain.js/pull/603.

robertleeplummerjr commented 3 years ago

Merged the above. Picking up src/lookup.js

yashshah1 commented 3 years ago

Hi, I'd like to work on this as well. Can you tell me which file is not being worked on?

BrainJS / brain.js

Migrate to TypeScript #551